Click here to return to the KiXtart HelpDesk main page...

KiXtart Macro Reference

Macros can be used anywhere an expression is expected. Supported macros are defined in the following table.

Macro

Definition

@ADDRESS

Address of the network adapter

@COMMENT

User comment

@CURDIR

Current directory

@DATE

Date (in the format YYYY/MM/DD)

@DAY

Day of the week (Monday, Tuesday, and so on)

@DOMAIN

Domain or workgroup the computer belongs to

@DOS

Version of Windows NT

@ERROR

Return code of the most recent command or function. A return code of 0 means the command or function was successful. Any other value indicates an error.

@FULLNAME

Full name of current user

@HOMEDIR

Short name of the directory part of home directory

@HOMEDRIVE*

Drive letter of drive containing home directory

@HOMESHR

Server and share name part of home directory

@HOSTNAME

Fully qualified TCP/IP host name (including TCP/IP domain name)

@INWIN

Operating system: 1 = Windows NT; 2 = Windows 9x

@IPADDRESSx

TCP/IP address (possible values for x are 0 - 3).
Note   Addresses are padded so that the resulting string always consists of four sets of three characters separated by periods. For example, if your IP address is 123.45.6.7, @IPADDRESS0 is 123. 45. 6. 7.

@KIX

Version of KiXtart

@LANROOT

Directory where network software resides (usually Systemroot\System32)

@LDOMAIN*

Logon domain

@LDRIVE

Drive that is redirected to \\logonserver\NETLOGON

@LM

Version of network software

@LONGHOMEDIR

Long name of the directory part of home directory

@LSERVER

Logon server

@MAXPWAGE

Maximum password age

@MDAYNO

Day of the month (1-31)

@MONTHNO

Months since January (1-12)

@MONTH

Name of the month

@PRIMARYGROUP*

Current user's primary group

@PRIV

User's privilege level (GUEST, USER, ADMIN)

@PWAGE

Password age

@RAS

Number of active Remote Access Service (RAS) connections

@RSERVER*

KXRPC server used for the current session

@SCRIPTDIR

Directory of current script

@SERROR

Error text corresponding with @ERROR

@SID*

Current user's Windows NT Security Identifier (SID)

@STARTDIR

Directory from which KiXtart was started

@SYSLANG

Full English name of the language of the operating system specified in the format defined by  ISO Standard 639. (example : “0413Dutch (Standard)”).

@TIME

Current time (in the format HH:MM:SS)

@USERID

Current user's Windows NT user ID

@USERLANG

Full English name of the language selected by the current user specified in the format defined by  ISO Standard 639. (example : “0413Dutch (Standard)”).

@WDAYNO

Days since Sunday (1 – 7)

@WKSTA

Computer name

@WUSERID

Current user's Windows user ID

@YDAYNO

Days since January 1 (1 – 365)

@YEAR

Current year

*Available on computers running Windows 9x only if the KiXtart RPC service is running.


Note

During the logon sequence, WUSERID is empty on computers running Windows 9x if Windows NT Networking has been configured as the system's primary network provider.

The following examples show the correct use of KiXtart macros:

@LM              "2.10"

@DATE            "1997/10/03"

DISPLAY @USERID + ".TXT"       displays the file "RUUDV.TXT"

CD "\DATA\" + @DOMAIN       changes the current directory to "\DATA\your-domain"