Reserved Variable Names

Top  Previous  Next

S

A

W

WS

ü

ü

The following variable names are used by EMUEScript to provide pre-defined or defined during script processing values for use in the processing of a script.

 

Variable Name

Value

&DATE

Todays date in a  MMDDYY format (January 2nd 2004 = 010204)

&TIME

The current time in a hhmmss format (11:54 PM  = 235400)

&TODAY

Todays date in a MM/DD/YYYY format (January 2nd 2004 = 01/02/2004)

&NOW

The current time in the HH:mm:ss format (11:54 PM = 23:54:00)

&InputFileLineCount

The total number of lines in the current input file.

&InputFileName

The name of the current input file without the path or extension.

&FullInputFileName

The full path and name of the current input file including extension.

&InputFilePosition

Current position in the input file.

&NOT

Returns the Logical NOT sign, primarily for use in a PASTE command.

&ScriptFileName

The name of the script file without the path or extension.

Note: If a script starts another script with a GoToScript command, and the second script uses this variable, the name of the original script file will be returned.

&FullScriptFileName

The full path and name of the current script file including extension.

&LogFileName

The name of the log file, as defined by SETSTARTUP LogFile, without the path or extension.

&FullLogFileName

The name of the log file, as defined by SETSTARTUP Logfile, including path and extension.

Spaces

A literal string containing 80 spaces.

Note: When used in a comparison, the length of this string of spaces is changed to be the same length as the length of the string to which it is being compared.

&CRLF

Carriage return line feed.  Adds a new line to a string.

&CR

Carriage return.  Signifies a new line in some platforms.

&LF

Line feed.  Signifies a new line in some platforms.

&Tab

Returns a tab.

&DoubleQuote

Returns a double quote (").

&CommandLineValue

Returns the value provided with the /CommandLineValue command line switch.

&Line1Text

Returns the text that appears on row one of the terminal window with white spaces trimmed.  There is a variable (&Line2Text, &Line3Text, etc) for each row on the terminal.

&ErrorMessage

Returns a description of the last error trapped by EMUE's error handling.

&ErrorCategory

Returns an alpha code that corresponds to the category of the error for the last error trapped by EMUE's error handling.

&ErrorNumber

Returns a numeric value that indicates the exact error within a category for the last error trapped by EMUE's error handling.

&ErrorID

Returns the ID of the last error trapped by EMUE's error handling.

&ErrorLineNumber

Returns the Line Number of the error for the last error trapped by EMUE's error handling.

&ExceptionCount

Variable stores number of exceptions as determined by the user. Value is incremented by IncrementExceptionCount command.

&EMUEPath

Returns the path and file name of the EMUE Executable.

&EMUEVersion

Returns the version number for the EMUE installation where the script is running.