System Variables

Top  Previous  Next

 

OS_VER

Operating System

WIN_DIR

Windows Directory Path

SYS_DIR

Windows System Directory Path

SYS_NATIVE

Native System Directory Path Bypassing 64 Bit Redirection

TEMP_DIR

Windows Temp Directory Path

DESKTOP_DIR

User's Desktop  Path

USERDOCUMENTS_DIR

User's Documents Path

PROGRAM_FILES

Program Files Folder (Will be x86 folder if running on x64)

PROGRAM_FILES_NATIVE

Native Program Files Folder (e.g. "Program Files" not (x86) on x64)

OS_PLATFORM

Operating System Platform - i.e. WIN32 or WIN64

 

The above variables store their values in upper case.

 

USER_NAME

Current Username

COMPUTER_NAME

Computer Name

MSCHED_VER

Macro Scheduler version number

SCRIPT_DIR

Directory of running script

SCRIPT_FILE

Filename of running script

COMMAND_LINE

Full command line string (path of running executable and parameters passed on the command line)

MACRO_PARMS

Parameters passed by Macro> command

CWD

Current Directory

_LINE_NUM

Stores the current line number being executed



WW_TIMEOUT

Timeout value from WaitWindowOpen / Closed

WW_RESULT

Result from WaitWindowOpen / Closed

WCC_RESULT

Result from WaitCursorChanged

WSI_TIMEOUT

Used to set a timeout value for WaitScreenImage

WSI_TIMEDOUT

Indicates whether or not WaitScreenImage timed out

WST_TIMEOUT

Used to set a timeout value for WaitScreenText

DDE_TIMEDOUT

Timeout value from DDERequest

RP_WAIT

Switches waiting for program termination on and off in RunProgram

RP_WINDOWMODE

Used to set window mode for RunProgram

RP_RESULT

Used to store return code from RunProgram

RP_ADMIN

Set to 1 to make RunProgram run as admin

RP_DISPLAYERROR

Allows RunProgram error messages to be turned off/on

RP_WIN64PROCESS

Set to 1 to disable 64 bit redirection to make Run Program run 64 bit process

MSG_STAYONTOP

Used to set message to stay on top in Message / MessageModal

MSG_CENTERED

Used to set message box to center

MSG_WIDTH

Used to set the width of the message box

MSG_HEIGHT

Used to set the height of the message box

MSG_XPOS

Used to set the X position of the message box

MSG_YPOS

Used to set the Y position of the message box

SK_DELAY

Millisecond delay to pause between sending characters in SendText

SK_IGNORECAPS

Set to 1 for Send to ignore caps lock and send characters as entered

SK_LEGACY

If Press/Release commands fail in Citrix/DOS, set this to 1 first.

PRESS_ALLOWVARS

Set to 1 to make Press/Release commands accept a variable for the key name

RND_SEED

Allows a seed to be set for the Random command

CF_OVERWRITE

Allows changing CopyFile to overwrite or rename on collision

FTP_STATUS

Used to switch off/on the FTP status window

FTP_PASSIVE

Used to toggle FTP passive mode

FTP_TIMEOUT

Timeout value for FTPGetFile/ FTPPutFile / FTPGetDirList

FTP_RESULT

Result of FTP commands

FTP_USETLS

Set type of TLS/SSL connection to use

SSL_CERT

Specify SSL certificate file

SSL_ROOT_CERT

Specify SSL root certificate file

SSL_KEY

Specify SSL key file

SENDMAIL_STATUS

Used to switch off/on the SMTPSendMail status window

SMTP_RESULT

Result of SMTPSendMail command.

SMTP_AUTH

Used to set SMTP authentication on or off

SMTP_USERID

Used for SMTP authentication

SMTP_PASSWORD

Used for SMTP authentication

SMTP_RECEIPT

Used to enable SMTP return receipt

SMTP_PORT

Used to optionally set the port of the SMTP server

SMTP_CCLIST

Set CC recipients for SMTPSendMail

SMTP_BCCLIST

Set BCC recipients for SMTPSendMail

SMTP_TIMEOUT

Timeout for SMTP connection (milliseconds)

POP3_STATUS

Used to switch off/on the RetrievePOP3 status window

POP3_PORT

Used to set the POP3 port (defaults to 110)

POP3_TIMEOUT

Used to set a POP3 timeout

POP3_DELETE

Used to tell RetrievePOP3 to delete messages from the server

POP3_MSGSIZELIMIT

POP3 message size limit - RetrievePOP3 ignors messages larger

POP3_RESULT

Stores the result of the RetrievePOP3 command

POP3_MSGFILES

A semicolon delimited list of files downloaded by RetrievePOP3

REG_INTASSTR

Used to set RegistryWriteKey to write integers as strings/integers

WF_TYPE

Used to set the type of window the windowing functions should affect

VBS_TIMEOUT

Used to set the timeout for VBScript code

GAW_TYPE

Used for GetActiveWindow to set for active, or active child window.

INPUT_PASSWORD

Used to mask data entry in Input.

MF_RENAME

Set MoveFile to rename instead of physically move files.

APP_TITLE

Sets the application title of compiled macros.

MACRO_RESULT

Used to set/retrieve the result of a called macro.

WIN_USEHANDLE

Set to 1 to set all window functions to use/return window handles instead of window titles.  Set to 0 to set back to window titles.

WIN_REGEX

Set to 1 to use regular expressions instead of plain text for window title matching in all window functions.  Default is 0 (off).

WIN_SLEEP

Set to 1 to decrease CPU usage for (but slow down) WaitWindowOpen/Closed and OnEvent WINDOW_OPEN/NOTOPEN.

HTTP_TIMEOUT

Optional timeout value for HTTPRequest

HTTP_SSL

Specify whether to use SSL or not for HTTPRequest

STEP_DELAY

Sets a millisecond delay between each script line

CRYPT_LEVEL

Sets the encryption strength for Crypt command

GFL_TYPE

Set to 1 to make GetFileList return directories only

FIP_SCANPIXELS

Used to alter the number of random pixels FindImagePos scans

WLN_NOCRLF

Set to 1 to make WriteLn omit line break.

WLN_ENCODING

Set to UNICODE to make WriteLn output Unicode (anything else/default is ANSI)



CR

Carriage Return

LF

Line Feed

CRLF

Carriage Return, Line Feed Combination (to force a new line)

TAB

Tab character

SPACE

Space character

NULLCHAR

Null Character - Chr(0)



_DUMP_VARS

Set to 1 to dump all variable names and values to log file.

_WRITE_LOG_FILE

Set to 0 to temporarily disable logging.  Set to 1 to enable.



VAREXPLICIT

Sets variable resolution method - see Using Variables.

IGNORESPACES

Set script to ignore leading and trailing spaces. See Using Variables.

IGNOREERRORS

Set to 1 to ignore script error messages.  Does not apply to VBScript errors (use on error next etc for VBScript errors).  Set back to 0 for default behaviour.

DISABLE_COMPLEX_EXPRESSIONS

Set to 1 to disable complex expressions.  Complex expressions will be seen as literal strings/regular variables.



DECIMAL_SEPARATOR

Sets/retrieves the character used as the decimal separator in floating point/currency numbers.  Default is "."

THOUSAND_SEPARATOR

Sets/retrieves the character used as the thousand separator in numbers.  Default is ","