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

KiXtart 2001 Manual

KiXtart Function Reference

Bold items are new to this release:

Abs
AddKey
AddPrinterConnection
AddProgramGroup
AddProgramItem
Asc
AScan
At
BackupEventLog
Box
CDbl
Chr
CInt
ClearEventLog
Close
CompareFileTimes
CreateObject
CStr
DecToHex
DelKey
DelPrinterConnection
DelProgramGroup
DelProgramItem
DelTree
DelValue
Dir
EnumGroup
EnumIpInfo
EnumKey
EnumLocalGroup
EnumValue
Execute
Exist
ExistKey
ExpandEnvironmentVars
Fix
FormatNumber
FreeFileHandle
GetDiskSpace
GetFileAttr
GetFileSize
GetFileTime
GetFileVersion
GetObject
IIF
InGroup
InStr
InStrRev
Int
IsDeclared
Join
KbHit
KeyExist
LCase
Len
Left
LoadHive
LoadKey
LogEvent
Logoff
LTrim
MemorySize
MessageBox
Open

ReadLine
ReadProfileString
ReadType
ReadValue
RedirectOutput
Right
Rnd
Round
RTrim
SaveKey
SendKeys
SendMessage
SetAscii
SetConsole
SetDefaultPrinter
SetFileAttr
SetFocus
SetOption
SetFocus
SetSystemState
SetTitle
SetWallpaper
ShowProgramGroup
ShutDown
SidToName
Split
SRnd
Substr
Trim
Ubound
UCase
UnloadHive
Val
VarType
VarTypeName
WriteLine
WriteProfileString
WriteValue
Returns the absolute value of a number
Add a key to registry
Add a connection to a network printer (NT only)
Create a new program group
Add/replace an item in current program group
Returns ASCII code of character
Searches an array for a specific expression
Place the cursor at the place indicated
Backs up an NT event log
Draws a text box
Casts an expression to a variant of subtype Double
Returns ASCII representation of numeric value
Casts an expression to a variant of subtype Integer
Clears an NT event log
Closes an ASCII file opened with OPEN
Compares the file date and time of two files
Launches the COM/OLE Automation server
RCasts an expression to a variant of subtype String
Returns the HEX equivalent given a decimal value
Delete key from registry
Remove a connection to a network printer (NT only)
Delete a program group
Delete a program item from a program group
Delete key from registry, including subkeys
Delete value of key from registry
Enumerates directories
Returns name of global group the user is member of
Enumerates TCP/IP information of network adapters
Returns name of subkey of key
Returns name of local group the user is member of
Returns name of value of key
Executes a piece of script
Checks if a file exists
Checks if a Registry Key exists
Expands environment variables in a string
Removes the fractional part of number and returns the resulting integer value
Returns an expression formatted as a number
Returns an available file handle number
Returns free disk space (in Kbytes)
Retrieves attributes of a file
Returns the size (in bytes) of a file
Retrieves the date & time of a file
Returns the version string of a file
Gets a COM object from a file stored on disk
Immediate IF
Checks for membership of user of specified group
Searches for a string within a string (left to right)
Searches for a string within a string (right to left)
Removes the fractional part of number and returns the resulting integer value
Returns a Boolean value indicating whether a variable has been declared
Returns a string created by joining a number of substrings contained in an array
Checks the console for keyboard input
Checks for the existence of a registry subkey
Returns string in lower case
Returns length of a string
Returns X characters from the left side of a string
Load a registry hive
Loads (overwrites!) key (sub keys and values)
LogEvent
Logs current user off
Strips leading spaces from string
Returns memory statistics, in Megabytes
Displays a standard Windows dialog box
Opens an ASCII file
Reads a line from an ASCII file opened with OPEN
Read string from an .ini file
Returns ASCII representation of type (eg: REG_SZ)
Returns ASCII representation of value
Redirects all output to a file
Returns X characters from the right side of a string
Returns a pseudo random number
Returns a number rounded to a specified number of decimal places
Strips trailing spaces from string
Saves entire key (including sub keys and values)
Sends keystrokes to the focused application
Send a message to another user or workstation
Enables/disables ASCII output
Change display mode of console
Sets the default printer
Sets attributes of a file
Sets focus to a specific application
Enables/disables global settings of the interpreter
Changes the (power) state of the local system
Sets the Window title of the current console
Sets the current wallpaper
Change display status of a program group
Shutdown or reboot local or remote system
Translates a Security Identifier (SID) into a name
splits a single string into an array given a delimiter
Sets the starting point for generating pseudorandom integers
Returns a substring from a string
Strips leading and trailing spaces from a string
Returns the largest available subscript for an array
Returns string in upper case
Unload a registry hive
Returns the numerical value of a string
Returns an integer value indicating the subtype of a variable
Returns a string that provides type info. about a variable
Write a line of text to a file
Write string to an ini-file
Write single value to registry

Most functions take one or more string or numeric expressions as parameters. String parameters are indicated by double quotation marks around the parameter name. Certain functions allow for optional parameters. If you omit these parameters, the function uses a default value instead.

Return Values

Most functions return either a string or a numeric value, and can thus be used anywhere an expression is expected. Most functions also set the values of @ERROR and @SERROR, so you can verify whether or not the function was successful.

Registry Functions

All registry functions use the following format to specify registry subkeys:
[\\remote_computer_name\][Key\]Subkey

Remote_computer_name can be any valid computer name in UNC format (preceded by two backslashes). If you do not specify a remote_computer_name, the program defaults to the local registry.

Key can be any of the main registry trees: HKEY_LOCAL_MACHINE (or HKLM in short), HKEY_USERS (HKU), HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU) or HKEY_CURRENT_CONFIG (HKCC). If you do not specify a root key, KiXtart will use HKEY_CURRENT_USER as the default. 

Subkey can be any valid registry subkey. If the name of a subkey contains spaces, enclose the entire expression in quotation marks.

The following examples show correct syntax for registry functions:

"
\\VLEERBEER\HKEY_LOCAL_MACHINE\CONTROL"
"HKEY_CURRENT_USER\Program Groups\Games"
"Control Panel\International\Sorting Order"
"HKCU\Program Groups\Games"


Note: When gaining access to a remote registry, you can only specify either HKEY_LOCAL_MACHINE or HKEY_USERS. Also, if you want to gain access to a remote registry from Windows 9x, you must enable remote registry access. For more information, see the instructions in the Admin\Nettools\Remotreg directory on the Windows 9x CD.