System Variables by Category

System Variables for General Use

Values "Permanently" Set

$ClipPath takes a path name from the registry.

$DBPath takes a path name from the database path configuration option.

$False provides a "false" value for comparison.

$HelpFile contains the name of a file containing help topics.

$ImagePath takes a path name from the registry.

$Null provides a "null" value for comparison.

$TimeSecs gives the number of seconds elapsed since 12:00 am, 1 January 1970.

$True provides a "true" value for comparison.

$WorkPath takes a path name from the work path configuration option.

$ZimOS identifies the operating system under which the software is currently running.

$ZimPath takes a path name from the [ZIM] environment variable in the registry.

$ZimProduct identifies the Zim product currently being used.

$ZimVersion identifies the software version currently being used.

Values Derived from the Operating System

$Date contains the operating system's current date setting.

$GroupID contains the current user's operating system group ID.

$ScreenHeight contains the logical height of the application window (BACKSCREEN) in rows.

$ScreenWidth contains the logical width of the application window (BACKSCREEN) in columns.

$Time contains the operating system's current time setting.

$UserID contains the current user's operating system user ID.

Values Periodically Set/Reset by the Software or the Developer

Last Event

Event contains information about the last event.

Input Cursor Positioning

$CursorCol contains a window column number.

$CursorRow contains a window row number.

$CursorScreenCol contains the screen column number.

$CursorScreenRow contains the screen row number.

$Direction indicates the direction in which focus was moving.

Current Set

$Located contains the number of records that met the conditions specified in a LOCATE command.

$MemberCount contains the number of records processed by a set-processing command.

$SetCount contains the number of records found by the last FIND command.

Error or Transaction Status

$ErrCode contains the error code generated by the last command executed.

$ErrLevel contains the error severity level generated by the last command executed.

$InTransaction indicates whether an explicit transaction is currently in progress.

$LastErrCode contains the error code generated by the last command that returned an error code.

$LastErrLevel contains the error severity level generated by the last command that returned an error severity level.

$MaxErrLevel contains the highest error severity level generated by any command up to the current point in the application session.

Selected Editing and Graphics Programs

$Editor contains the name of a text-editing software package.

$Graphics contains the name of a graphics software program.

Security

$ZGroupID contains the current user's Zim group identifier.

$ZUserID contains the current user's Zim user identifier.

Reports

$Page contains the current report page number.

System Variables for Use with Forms or Displays

Last Event in the Current Form or Display

ThisForm contains information about the current form at the time of the last event in the current window.

System Variables for Use with Menus

 Last Event in the Current Menu

ThisMenu contains information about the current menu at the time of the last event in the current window.

System Variables for Use with Windows

 Last Event in the Current Window

ThisWindow contains information about the current window at the time of the last event.

$WindowPSHeight contains the logical height, in character rows, of the current window.

$WindowPSWidth contains the logical width, in character columns, of the current window.