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

KiXtart 2001 Manual

Keyword Index
A complete listing of all commands, functions and macros in alphabetical order

A B C D E F G H I K L M O P Q R S T U V W Y

Bold items are new to this release

Keyword Description Type
? Print / display Command
: Denote label for goto/gosub Command
; Denote comments Command
Abs( ) Returns the absolute value of a number Function
AddKey( ) Add a key to registry Function
AddPrinterConnection( ) Add a connection to a network printer (NT only) Function
AddProgramGroup( ) Create a new program group Function
AddProgramItem( ) Add/replace an item in current program group Function
@Address Address of the network adapter   Macro
Asc( ) Returns ASCII code of character Function
AScan( ) Searches an array for a specific expression Function
At( ) Place the cursor at the place indicated Function
BackupEventLog( ) Backs up an NT event log Function
Beep Beep speaker Command
Big Sets character mode to large characters (8x8) Command
Box( ) Draws a text box in a console window Function
Break On/Off (Re)set Ctrl-C/Break handling Command
@Build Build number of the operating system Macro
Call Execute a separate script Command
CD Change current directory Command
CDbl Casts an expression to a variant of subtype Double Function
Chr( ) Returns ASCII representation of numeric value Function
CInt( ) Casts an expression to a variant of subtype Integer Function
ClearEventLog( ) Clears an NT event log Function
Close( ) Closes an ASCII file opened with OPEN Function
CLS Clear the console screen Command
Color change fore-/background color Command
@Color Returns the current console color setting Macro
CompareFileTimes( ) Compares the file date and time of two files Function
Cookie1 Creates 'cookie' for the 9x Logon API Command
@Comment User comment  (Description field in User Manager) Macro
Copy Copy files Command
CreateObject( ) Launches the COM/OLE Automation server Function
@CPU Name of the CPU (e.g.: "Intel Pentium III") Macro
@CRLF Returns a carriage-return line-feed combination Macro
@CSD CSD information (eg: "Service Pack 1") Macro
CStr( ) Casts an expression to a variant of subtype String Function
@CurDir Current directory   Macro
@Date Date (in the format YYYY/MM/DD)   Macro
@Day Day of the week (Monday, Tuesday, and so on)   Macro
Debug On/Off Turn debug mode on or off during runtime Command
DecToHex( ) Returns the HEX equivalent given a decimal value Function
Del Delete files Command
DelKey( ) Delete key from registry Function
DelPrinterConnection( ) Remove a connection to a network printer (NT only) Function
DelProgramGroup( ) Delete a program group Function
DelProgramItem( ) Delete a program item from a program group Function
DelTree( ) Delete key from registry, including subkeys Function
DelValue( ) Delete value of key from registry Function
Dim Dimension a variable Command
Dir Enumerates directories Function
Display Display contents of a text file Command
Do Until Loop the loop Command
@Domain Domain or workgroup the computer belongs to   Macro
@DOS Version of Windows NT Macro
EnumGroup( ) Returns name of global group the user is member of Function
EnumIpInfo( ) Enumerates TCP/IP information of network adapters Function
EnumKey( ) Returns name of subkey of key Function
EnumLocalGroup( ) Returns name of local group the user is member of Function
EnumValue( ) Returns name of value of key Function
@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.   Macro
Execute( ) Executes a piece of script Function
Exist( ) Checks if a file exists Function
Exit exit current script, optionally with return code Command
ExpandEnvironmentVars( ) Expands environment variables in a string Function
Fix( ) Removes the fractional part of number and returns the resulting integer value Function
FlushKb Remove any keystrokes from keyboard buffer Command
For ... Each Control statements to enumerate arrays Command
For ... Next Control stmts. to conditionally execute a set of statements Command
FormatNumber( ) Returns an expression formatted as a number Function
FreeFileHandle( ) Returns an available file handle number Function
@FullName Full name of current user   Macro
Function ... EndFunction  Definition of user defined functions Command
Get Wait for single keystroke Command
GetDiskSpace( ) Returns free disk space (in Kbytes) Function
GetFileAttr( ) Retrieves attributes of a file Function
GetFileSize( ) Returns the size (in bytes) of a file Function
GetFileTime( ) Retrieves the date & time of a file Function
GetFileVersion( ) Returns the version string of a file Function
GetObject( ) Gets a COM object from a file stored on disk Function
GetS Accept a string of chars Command
Global Declare one of more global variables Command
Go Change the current drive Command
Gosub Call subroutine at label Command
Goto Jump to label Command
@HomeDir Short name of the directory part of home directory   Macro
@HomeDrive* Drive letter of drive containing home directory   Macro
@HomeShr Server and share name part of home directory  Macro
@HostName Fully qualified TCP/IP host name (including TCP/IP domain name)   Macro
If ... Else ...Endif Standard if/else construct Command
IIF( ) Immediate IF Function
InGroup( ) Checks for membership of user of specified group Function
Int( ) Removes the fractional part of number and returns the resulting integer value Function
@InWin Operating system: 1 = Windows NT; 2 = Windows 9x Macro
@IPAddressX TCP/IP address (possible values for x are 0 - 3). Addresses are padded so that the resulting string always consists of four sets of three characters separated by periods (a total of 15 characters). For example, if your IP address is 123.45.6.7, @IPADDRESS0 is "123. 45. 6. 7".   Macro
IsDeclared( ) Returns a Boolean value indicating whether a variable has been declared Function
InStr( ) Searches a string in a string (parsing from left to tight) Function
InStrRev( ) Returns index of a substring in another string (parsing from right to left) Function
Join( ) Returns a string created by joining a number of substrings contained in an array Function
KbHit( ) Checks the console for keyboard input Function
KeyExist( ) Checks for the existence of a registry subkey Function
@KiX Version of KiXtart   Macro
@LanRoot Directory where network software resides (usually Systemroot\System32)   Macro
LCase Returns string in lower case Function
@LDomain* Logon (authenticating) domain   Macro
@LDrive Drive that is redirected to \\logonserver\NETLOGON Macro
Len( ) Returns length of a string Function
Left( ) Returns a specified number of characters from the left side of a string Function
@LM Version of network software Macro
LoadHive( ) Load a registry hive Function
LoadKey( ) Loads (overwrites!) key (sub keys and values) Function
LogEvent( ) Creates an entry in the NT event log Function
Logoff( ) Logs current user off Function
@LogonMode If 1, indicates that KiXtart assumes to be running during the logon sequence Macro
@LongHomeDir Long name of the directory part of home directory Macro
@LServer Logon server   Macro
LTrim( ) Strips leading spaces from string Function
@MaxPWAge Maximum password age   Macro
MD Creates a folder on disk Command
@MDayNo Day of the month (1-31)   Macro
MemorySize( ) Returns memory statistics, in Megabytes Function
MessageBox( ) Displays a standard Windows dialog box Function
@MHz Approximation of the CPU speed (not available on Windows 9x) Macro
@Month Name of the month Macro
@MonthNo Month number (January=1, December=12)   Macro
Move Moves files and renames files and directories Command
@MSecs Milliseconds part of the current time Macro
Open( ) Opens an ASCII file Function
@PID Process ID of KiXtart (wkix32.exe or kix32.exe) Macro
Play Plays 'music' from SPK-file, string or WAV-file Command
@PrimaryGroup* Current user's primary group   Macro
@Priv User's privilege level (Guest, User, Admin)   Macro
@ProductSuite OS "Suite." Possible Values:
1 "Small Business"
2 "Enterprise"
4 "BackOffice"
8 "CommunicationServer"
16 "Terminal Server"
32 "Small Business (Restricted)"
64 "Embedded NT"
128 "DataCenter"
256 "Single User Terminal Server"
512 "Home Edition"
1024 "Blade Server"
Macro
@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 Home Edition Tablet PC"
"Windows XP Professional"
"Windows XP Professional Tablet PC"
"Windows Server 2003"
"Windows Server 2003 Domain Controller"		 Macro
@PWAge Password age   Macro
Quit Exit script, optionally with an exitcode Command
@RAS Number of active Remote Access Service (RAS) connections   Macro
RD Remove folder from disk Command
ReadLine( ) Reads a line from an ASCII file opened with OPEN Function
ReadProfileString( ) Read string from an .ini file Function
ReadType( ) Returns ASCII representation of type (eg: REG_SZ) Function
ReadValue( ) Returns ASCII representation of value Function
ReDim Re-declare arrays Command
RedirectOutput( ) Redirects all output to a file Function
@Result Returns command-specific information (e.g.: the drive letter of an automatic redirection command) Macro
Return Exits a subroutine or script Command
Right( ) Returns a specified number of characters from the right side of a string Function
Rnd( ) Returns a pseudo random number Function
Round( ) Returns a number rounded to a specified number of decimal places Function
@RServer* KXRPC server used for the current session Macro
RTrim( ) Strips trailing spaces from string Function
Run WinExec's a program (script continues) Command
SaveKey( ) Saves entire key (including sub keys and values) Function
@ScriptDir Directory of current script Macro
@ScriptExe Indicates the version of the KiXtart executable Macro
@ScriptName Name of the current script Macro
Select ... Case ... EndSelect 'CASE' statement Command
SendKeys( ) Sends keystrokes to the focused application Function
SendMessage( ) Send a message to another user or workstation Function
@SError Error text corresponding with @ERROR Macro
Set Sets variables in environment CURRENT_USER (NT) Command
SetL Sets variables in local environment (NT) Command
SetM Sets variables in environment. of LOCAL_MACHINE (NT) Command
SetAscii( ) Enables/disables ASCII output Function
SetConsole( ) Change display mode of console Function
SetDefaultPrinter( ) Sets the default printer Function
SetFileAttr( ) Sets attributes of a file Function
SetFocus( ) Sets focus to a specific application Function
SetOption( ) Enables/disables global settings of the interpreter Function
SetSystemState( ) Changes the (power) state of the local system Function
SetTime Synchronize local time with time on server Command
SetTitle( ) Sets the Window title of the current console Function
SetWallpaper( ) Sets the current wallpaper Function
Shell Executes a program, and waits for completion Command
ShowProgramGroup( ) Change display status of a program group Function
ShutDown( ) Shutdown or reboot local or remote system Function
@SID* Current user's Windows NT Security Identifier (SID) Macro
SidToName( ) Translates a Security Identifier (SID) into a name Function
@Site** Name of the site in which the system resides Macro
Sleep Suspends script for xx seconds Command
Small Resets character mode to normal Command
Split( ) Splits a single string into an array given a delimiter Function
SRnd( ) Sets the starting point for generating pseudorandom integers Function
@StartDir Directory from which KiXtart was started Macro
Substr( ) Returns a substring from a string Function
@SysLang Full English name of the language of the operating system specified in the format defined by ISO Standard 639. (example : “0413Dutch (Standard)”).   Macro
@Ticks Milliseconds elapsed since computer was last booted. Macro
@TIME Current time (in the format HH:MM:SS)  Macro
Trim( ) Strips leading and trailing spaces from a string Function
Ubound( ) Returns the largest available subscript for an array Function
UCase( ) Returns string in upper case Function
UnloadHive( ) Unload a registry hive Function
Use Connects/disconnects to/from network shares Command
@USERID Current user's Windows NT user ID   Macro
@USERLANG Full English name of the language selected by the current user specified in the format defined by ISO Standard 639. (example : “0413Dutch (Standard)”).  Macro
Val( ) Returns the numerical value of a string Function
VarType( ) Returns an integer value indicating the subtype of a variable Function
VarTypeName( ) Returns a string that provides type info. about a variable Function
@WDayNo Days since Sunday (1 – 7)   Macro
While ... Loop loop the loop Command
@WKSTA Computer name Macro
WriteLine( ) Write a line of text to a file Function
WriteProfileString( ) Write string to an ini-file Function
WriteValue( ) Write single value to registry Function
@WUserID Current user's Windows user ID Macro
@YDayNo Days since January 1 (1 – 365)   Macro
@Year   Current year   Macro 

* Available on computers running Windows 9x only if the KiXtart RPC service is running.
** Only available on clients with full Active Directory support.