KiXtart Language Reference
[ KiXtart AutoIt Batch VBScript HTA PowerShell Windows Command Lines Other Command Line Utilities ]
- : - Defines a label within a script
- ; - Remark or comment
- ? - New line
- Beep - Causes the system to emit a "beep" sound
- Big - Sets the console window font size to seven spaces tall, by eight ...
- Break - Enables/disables the CTRL+C/BREAK keys and the Close command.
- Call - Executes another KiXtart script file
- Case - Identifies a condition in a Select statement
- CD - Changes the current directory
- CLS - Clears the console window of text
- Color - Sets the forground and background color of console output
- Cookie1 - Creates a semaphore-file used by the Windows 9x Logon API to dete...
- Copy - Creates a copy of one or more files
- Debug - Starts or stops debugging during script execution
- Del - Deletes one or more files
- Dim - Declare one or more local variables
- Display - Displays the contents of a file in the console
- Do - Specifies statements to process for a Do/Until loop
- Each - Identifies element variable when looping through values in an arr...
- Else - Identifies action to take if the expression identified in an If s...
- EndFunction - Identifies the end the code for a user defined function (UDF)
- EndIf - Marks the end of an If statement
- EndSelect - Identifies the end of a Select statement
- Exit - Exits the current called script or UDF
- FlushKB - Clears the keyboard buffer
- For - Performs a loop while calculating a counter variable
- Function - Identifies a user defined function (UDF)
- Get - Stores a single character from the keyboard in a variable
- Gets - Obtains a series of characters from the keyboard until the Enter ...
- Global - Declare one or more global variables
- Go - Changes the current drive
- Gosub - Sends the script to a specified label, where it then jumps back t...
- Goto - Instructs the script to jump to another location in the script
- If - Conditional statement to specify action should be taken only if a...
- Include - Includes script code from another file in the current script
- Loop - Identifies the end of a While statement
- MD - Creates a directory
- Move - Moves or renames files and directories
- Next - Identifies the end of the code in a For loop
- Password - Sets password to be used with USE
- Play - Plays a .WAV or .SPK audio file and may even be passed a .SPK-for...
- Quit - Ends the KiXtart process
- RD - Removes a directory
- ReDim - Reallocates storage space of an array
- Return - Triggers the return of a GoSub routine
- Run - Executes the specified command line and continues on through the ...
- Select - Identifies the start of a Select statement
- Set - Create user environment variables
- SetL - Sets an environment variable in the local environment that you se...
- SetM - Sets an environment variable for the machine, known as a system e...
- SetTime - Sets the local system time
- Shell - Executes the specified command line and waits for it to complete ...
- Sleep - Instructs KiXtart to pause for a specified period of time
- Small - Restores the font size to normal following use of the Big command
- Until - Identifies expression that will end a Do/Until loop
- Use - Connect, disconnect or list network connections
- While - Performs a loop while a specified expression is true
- Abs - Removes negative/minus sign from a number
- AddKey - Adds the specified subkey to the registry
- AddPrinterConnection - Adds a new printer connection
- AddProgramGroup - Instructs Program Manager to create a new program group
- AddProgramItem - Instructs Program Manager to add an icon to the active program gr...
- Asc - Returns the ASCII code of the character specified
- AScan - Searches an array for an element containing the same value as an ...
- At - Places the cursor in the position indicated
- BackupEventLog - Creates a backup of a Windows NT eventlog
- Box - Draws a box in the console window
- Cdbl - Converts an expression to a variant of subtype Double
- Chr - Inserts a character as specified by its ASCII value
- Cint - Converts an expression into a Variant of subtype Integer
- ClearEventLog - Clears a specified Windows NT event log
- Close - Closes a file previously opened by the Open function
- CompareFileTimes - Compares the date and time of two files
- CreateObject - Returns a handle to a COM automation object through which the obj...
- Cstr - Converts an expression into a Variant of subtype String
- DecToHex - Returns the hexadecimal representation of a decimal value
- DelKey - Deletes the specified submkey form the registry
- DelPrinterConnection - Deletes a connection to a printer that was established by using A...
- DelProgramGroup - Instructs Program Manager to delete an existing program group
- DelProgramItem - Instructs Program Manager to delete an item from the active progr...
- DelTree - Deletes a subkey (and any subkeys within it) from the registry
- DelValue - Deletes a value from the registry
- Dir - Enumerates the files in a directory
- EnumGroup - Enumerates all groups of which the current user is a member
- EnumIPInfo - Enumerates TCP/IP information of network adapters on the local sy...
- EnumKey - Lists the names of the subkeys contained in a registry key or sub...
- EnumLocalGroup - Enumerates local group membership of the current user on a truste...
- EnumValue - Function lists the names of the registry entries contained in a s...
- Execute - Instructs KiXtart to interpret a string as script code
- Exist - Determines the presence of a file or directory
- ExistKey - Checks for the existance of a refistry subkey
- ExpandEnvironmentVars - Expands any environment variables inside a string to the correspo...
- Fix - Removes the fractional part of a number and returns the resulting...
- FormatNumber - Returns an expression formatted as a number
- FreeFileHandle - Returns the first available file handle
- GetDiskSpace - Returns the number of free kilobytes (KB) available to the curren...
- GetFileAttr - Returns the attributes of a file
- GetFileSize - Returns the size of a file in bytes
- GetFileTime - Returns the date and time information of a file (YYYY/MM/DD HH:MM...
- GetFileVersion - Returns the specified version information string of a file
- GetObject - Gets a COM object either from memory or a file stored on disk and...
- IIf - Returns one of two values depending on the value of a logical exp...
- InGroup - Checks whether the current user is a member of one or more groups
- InStr - Searches a string for the presence of a second string
- InStrRev - Searches a string for the presence of a second string, starting f...
- Int - Removes the fractional part of a number
- IsDeclared - Determines is a variable has been declared
- Join - Combines the contents of an array into a single deliminated varia...
- KBHit - Determines if the user has pressed a key
- KeyExist - Checks for the existence of a registry subkey
- Lcase - Changes a string to lowercase
- Left - Returns a specified number of characters from the left side of a ...
- Len - Returns the length of a string
- LoadHive - The LoadHive function creates a subkey under HKEY_USERS or HKEY_L...
- LoadKey - Loads a registry key (including its subkeys and values) from a fi...
- LogEvent - Logs an event in the Windows NT event log
- LogOff - Logs the current user off and ends the Windows session
- Ltrim - Strips leading spaces from an input string and returns the result
- MemorySize - Returns memory statistics, in Megabytes (MB)
- MessageBox - Displays a standard dialog box in Windows
- OLECallFunc - Accesses a method of an OLE Automation object that returns a valu...
- OLECallProc - Accesses a method of an OLE Automation object that does not retur...
- OLECreateObject - Launches an OLE Automation server and returns a handle
- OLEEnumObject - Retrieves the EnumerationHandle of a collection, or retrieves an ...
- OLEGetObject - Gets an object and returns a handle to the object
- OLEGetProperty - Returns the value of a specific property of an OLE Automation obj...
- OLEGetSubObject - Gets an object and returns a handle to the object
- OLEPutProperty - Sets the value of a specific property of an OLE Automation object
- OLEReleaseObject - Frees up any resources obtained when the OLE object was created.
- Open - Opens a text file
- ReadLine - Reads a line from a file
- ReadProfileString - Retrieves a string from an initialization file
- ReadType - Returns the ASCII representation of a registry value data type
- ReadValue - Reads a registry value and returns it as an ASCII string
- RedirectOutput - Redirects all screen output to a file
- Right - Returns a specified number of characters from the right side of a...
- Rnd - Returns a pseudo-random number
- Round - Rounds a value to a specified number of decimal places
- Rtrim - Strips trailing spaces from an input string and returns the resul...
- SaveKey - Saves a registry key (including its subkeys and value entries) to...
- SendKeys - Sends one or more keystrokes to the active window— as if typed at...
- SendMessage - Sends a message across the network to another user or workstation
- SetASCII - Enables and disables ASCII console output
- SetConsole - Changes the display state of the command-prompt window in which K...
- SetDefaultPrinter - Sets the default printer to which applications send print jobs
- SetFileAttr - Sets the attributes of a file
- SetFocus - Sets the input focus to the application specified
- SetOption - SetOption provides a means to enforce certain programming rules i...
- SetSystemState - Changes the (power) state of the computer
- SetTitle - Sets the title of the current console
- SetWallpaper - Sets the current wallpaper
- ShowProgramGroup - Instructs Program Manager to minimize, maximize, or restore the w...
- Shutdown - Shuts down or reboots a computer
- SIDtoName - Translates a Security Identifier (SID) into a name
- Split - Splits a deliminated string into an array
- SRnd - Sets the starting point for generating a series of pseudo-random ...
- SubStr - Returns a specified part of a string
- Trim - Strips leading and trailing spaces from an input string and retur...
- Ubound - Determine the total number of elements in an array
- Ucase - Returns a string in uppercase
- UnloadHive - Unloads a hive previously loaded using the LoadHive function
- Val - Converts a string to an integer
- VarType - Returns an integer value indicating the subtype of a variable
- VarTypeName - Returns a string that provides type information about a variable
- WriteLine - Appends a line to the end of a file
- WriteProfileString - Copies a string to an initialization file
- WriteValue - Creates a new key, adds another value-name to an existing key (an...
- @ADDRESS - First bound MAC address
- @BUILD - Windows OS build number
- @COLOR - The current console color setting
- @COMMENT - Current user profile comment
- @CPU - Name of the local computer CPU
- @CRLF - Carriage-return and Line-feed
- @CSD - Service Pack version for local system
- @CURDIR - Current directory
- @DATE - Current Date (YYYY/MM/DD)
- @DAY - Day of the week
- @DOMAIN - Domain or workgroup name to which the computer belongs
- @DOS - Windows version number
- @ERROR - Error code returned by previous function or command
- @FULLNAME - Name of the current user as entered their Windows profile
- @HOMEDIR - Returns the name of the directory portion of the current user hom...
- @HOMEDRIVE - Returns the letter representing the drive that is set to map to t...
- @HOMESHR - Returns the server and share name part of the user’s home directo...
- @HOSTNAME - Macro returns the fully qualified TCP/IP host name (including TCP...
- @INWIN - Determins if Windows is Win9x or WinNT
- @IPADDRESS0 - TCP/IP address of the first network interface card (NIC)
- @IPADDRESS1 - TCP/IP address of the second network interface card (NIC)
- @IPADDRESS2 - TCP/IP address of the third network interface card (NIC)
- @KIX - Returns the version of the executing KiXtart interpreter.
- @LANROOT - Location of Windows network software.
- @LDOMAIN - Returns the name of the domain to which the user has logged in
- @LDRIVE - Path to NETLOGON share
- @LM - Version of MS Lan Manager
- @LOGONMODE - Identifies if KiXtart is executing during the logon process
- @LONGHOMEDIR - Returns the "long name" directory of the home directory path
- @LSERVER - Name of the logon server
- @MAXPWAGE - Returns the system’s maximum password age
- @MDAYNO - Number of days since the first of the month (1-31)
- @MHZ - The approximate CPU speed of the local system
- @MONTH - The name of the current month
- @MONTHNO - Month number for the current year (1 – 12)
- @MSECS - Number of milliseconds pertaining to the current time
- @ONWOW64 - Identifies if running in the WOW64 environment on an Windows x64 ...
- @PID - The process ID of the KiXtart process
- @PRIMARYGROUP - Displays the current user's primary group
- @PRIV - The current user's privilege level
- @PRODUCTSUITE - provides Windows suite information
- @PRODUCTTYPE - Operating System type
- @PWAGE - The age of the current user's password
- @RAS - Returns the number of RAS connections
- @RESULT - Returns number of successful files for Copy, Move and Del command...
- @RSERVER - KXRPC server used for the current session
- @SCRIPTDIR - Identifies the directory of the current script
- @SCRIPTEXE - Identifies which KiXtart interpretor is in use (KiX32 or WKiX32)
- @SCRIPTNAME - The name of the current script being executed
- @SERROR - Returns the Win32 error text that equates to the value of @ERROR
- @SID - Current User SID
- @SITE - returns the name of the Active Directory (AD) site in which the s...
- @STARTDIR - returns the full path to the folder from which KiX32/wKiX32 was l...
- @SYSLANG - Returns the full English name of the language of the operating sy...
- @TICKS - Returns the number of milliseconds that have elapsed since the sy...
- @TIME - Returns the current time
- @TSSESSION - Indicates if script is running in a Terminal Services session
- @USERID - Current user's Windows NT user ID
- @USERLANG - A 32-bit value identifying the language in use by the current use...
- @WDAYNO - Returns the number of days since Sunday
- @WKSTA - Local computer name
- @WUSERID - The current user's Windows user ID.
- @YDAYNO - Returns the number of days since January 1
- @YEAR - Returns the current year
- & - Bitwise AND operation
- * - Multiply numbers
- + - Adds numbers together or appends strings to one another
- - - Subtract one number from another
- / - Divide numbers
- < - Less than
- <= - Less Than or Equal
- <> - Not equal
- = - Equal operator (case insensitive)
- == - Equal Operator (Case Sensitive)
- > - Greater than
- >= - Greater Than or Equal
- ^ - XOR
- | - Bitwise OR operation
- ~ - Binary NOT
- AND - Performs a logical conjunction on two expressions
- MOD - Divides numbers and return only the remainder
- NOT - Performs logical negation on an expression
- OR - Performs a logical disjunction on two expressions
Commands
Functions
Macros
Operators
iTripoli prides itself on providing top notch customer service
Find answers or open a ticket to ask directly, when opening a ticket we will suggest relavant articles to help you get answers as quickly and accurately as possible. Visit our support center now!