Script Start - User Profiles Simplified

KiXtart Macros

KiXtart macros can be used in your script configuration anywhere an expression is expected. During logon, these macros expand into values based on their definition. For example, when a user named GPBurdell logs on to a client machine, the @userid macro expands into GPBurdell. KiXtart macros have many practical uses. The UNC path, \\your-server\@userid, can be used to map a drive to a per-user share. The @lserver macro can be used to set the system time on legacy clients from the authenticating domain controller. Table 1 lists the supported KiXtart macros and their definitions.

Macro	Definition
@ADDRESS	Address of the network adapter
@BUILD	Build number of the operating system
@COLOR	Current console color setting
@COMMENT	User comment
@CPU	Name of the CPU (e.g.: "Intel Pentium III")
@CRLF	Carriage-return + Line-feed
@CSD	CSD information (e.g.: "Service Pack 1")
@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)
@KIX	KiXtart product name and version
@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
@LOGONMODE	If 1, indicates that KiXtart assumes to be running during the logon sequence
@LONGHOMEDIR	Long name of the directory part of home directory
@LSERVER	Logon server
@MAXPWAGE	Maximum password age
@MDAYNO	Day of the month (1-31)
@MHZ	Approximation of the CPU speed. Not available on Windows 9x.
@MONTHNO	Months since January (1-12)
@MONTH	Name of the month
@MSECS	Milliseconds part of the current time
@PID	Process ID of the KiXtart process
@PRIMARYGROUP*	Current user's primary group
@PRIV	User's privilege level (GUEST, USER, ADMIN)
@PRODUCTSUITE	OS suite. Combination of any of the following values: 1 - "Small Business" 2 - "Enterprise" 4 - "BackOffice" 8 - "CommunicationServer" 16 - "Terminal Server" 32 - "Small Business (Restricted)" 64 - "EmbeddedNT" 128 - "DataCenter" 256 - "Single user Terminal Server" 512 - "Home Edition" 1024 - "Blade Server"
@PRODUCTTYPE	OS type. Possible values: "Windows 95" "Windows 98" "Windows Me" "Windows NT Workstation" "Windows NT Server" "Windows NT Domain Controller" "Windows 2000 Professional" "Windows 2000 Server" "Windows 2000 Domain Controller" "Windows XP Home Edition" "Windows XP Professional" "Windows XP Home Edition Tablet PC" "Windows XP Professional Tablet PC" "Windows Server 2003" "Windows Server 2003 Domain Controller"
@PWAGE	Password age
@RAS	Number of active Remote Access Service (RAS) connections
@RESULT	Returns command specific information (e.g.: the drive letter of an automatic redirection command)
@RSERVER*	KXRPC server used for the current session
@SCRIPTDIR	Directory of current script
@SCRIPTEXE	Name of KiXtart executable ("KIX32.EXE", "WKIX32.EXE")
@SCRIPTNAME	Name of current script
@SERROR	Error text corresponding with @ERROR
@SID*	Current user's Windows NT Security Identifier (SID)
@SITE**	Name of the site in which the system resides
@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)")
@TICKS	Returns the number of milliseconds that have elapsed since the system was started
@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

Table 1: KiXtart Macros

NOTE: KiXtart macros denoted with a single asterisk can only be used on Windows 95, Windows 98, and Windows ME clients if the KXRPC Service is installed. KiXtart macros denoted with a double asterisk require an Active Directory domain infrastructure and full Active Directory support on your clients. Full Active Directory support is included as part of the base operating system on Windows 2000, Windows XP, and Windows 2003. On Windows NT 4.0, Windows 95, Windows 98, and Windows ME, you will need to install the Active Directory Client Extension to have full Active Directory support. The Active Directory Client Extension, commonly referred to as the DSClient, is available from Microsoft.