The size of the terminal screen in character rows.
Syntax
$screenheight
Return Value
A number. Cannot be reset by an application program.
Description
$ScreenHeight gives the height of the terminal screen in character rows.
In graphic environments, the number of rows depends on the font and point size used in the application window (BACKSCREEN).
See Also
$ScreenWidth
System Variables
ThisWindow
The size of the terminal screen in character columns.
Syntax
$screenwidth
Value
A number. Cannot be reset by an application program.
Description
$ScreenWidth gives the width of the terminal screen in character columns.
In graphic environments, the number of columns depends on the font and point size used in the application window (BACKSCREEN).
See Also
$ScreenHeight
System Variables
ThisWindow
Syntax
$ProgramFileName
Return Value
Character string (varalpha). Cannot be reset by an application program.
Comments
Contains the file system name of the disk file that contains the currently executing program. AREAS.ZIM or DIRS.ZIM entries that apply to the file are expanded, as are the special prefix characters (i.e. #,),^,~,”).
See Also
$filepath
Indicates the operating system under which ZXCLIENT is currently running.
Syntax
$ClientOS
Return Value
A number according to the following table. It cannot be reset by an application program.
| Value | Operating System |
|---|
| 1 | Microsoft Windows |
| 4 | Linux in General |
| 5 | Android |
| 6 | iOS |
| 7 | OS X |
$DBPath
File system path to the directory in which the application database is stored.
Syntax
$dbpath
Return Value
A character string. Cannot be reset by an application program.
Description
The $DBPath function is set to the value of the DBPath entry in the registry, or the value of the [ZIM] environment variable. If neither of the preceding values is set, the variable is set to the null string (which is interpreted as the current disk directory).
To indicate the current DBPath directory in a file name, start the name with a double quotation mark (“) character.
Path to the disk directory containing image files for use in forms.
Syntax
$imagepath
Return Value
A character string. Cannot be reset by an application program.
Description
$ImagePath is set to the value of the ImagePath entry in the registry. If no value is provided in the file, the variable is set to the null string (which is interpreted as the current disk directory).
For image objects (fields) in forms, $ImagePath indicates the disk directory in which the image files can be found.
To indicate the current ImagePath directory in a file name, start the name with a caret (^) character.
File system path to the directory to be used for Cut, Copy, and Paste operations that involve user interface objects in the Screen Painter.
Syntax
$clippath
Return Value
A character string. Cannot be reset by an application program.
Description
$ClipPath is set to the value of the ClipPath entry in the registry, or the value of the [ZIM] environment variable. If neither of the preceding values is set, the variable is set to the null string (which is interpreted as the current disk directory).
To indicate the current ClipPath directory in a file name, start the name with a tilde (~) character.
Note: How $ClipPath is set depends on the operating system under which the software is running.
File system path to the directory in which the Zim software is installed.
Syntax
$zimpath
Return Value
A path name. Cannot be reset by an application program.
Description
$ZimPath is set to the value of the Zim entry in the registry. If this value is not set, the variable is set to the null string (which is interpreted as the current disk directory).
To indicate the current ZimPath directory in a file name, start the name with an octothorpe (#) character.
Note: For Zim on Windows users, if $ZimPath is pointing to a directory that contains old DLLs, you can get the following error message:
ZIM caused Segment Load Failure in Module zim.exe @0002:511C.
Ensure that $ZimPath is not pointing to old DLLs.
Syntax
$ProgramName
Return Value
Character string (varalpha). Cannot be reset by an application program.
Comments
Contains the name of the currently executing program.
See Also
SET LEXTRACE
SET TRACE
Indicates the operating system under which Zim:X is currently running.
Syntax
$zimos
Return Value
A number as stated below. It cannot be reset by an application program.
| Value | Operating System |
|---|
| 3 | All Linux Flavours |
| 11 | Microsoft Windows |
| 12 | Linux Running on Android |