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 elapsed number of seconds since 12:00 am, 1 January 1970.
Syntax
$timesecs
Return Value
A number. Cannot be reset by an application program.
Description
The number of seconds that have elapsed since 12:00 am on 1 January 1970.
This variable is useful for measuring the number of seconds between two events.
See Also
$Date
$Time
A binary true value for comparison.
Syntax
$true
Return Value
Binary true (“1”). Cannot be reset by an application program.
Description
A “true” value for comparisons in logic expressions.
Example
if Event.ScrollingKey = $True
... commands ...
endif
See Also
$False
$Null
The current date.
Syntax
$date
Return Value
A number in date format (YYYYMMDD). Cannot be reset by an application program.
Description
The current date, as set in the operating system.
Example
From the zim prompt:
out $date
This extracts the DATE from the TIMESTAMP and then prints the proper $DayName.
OUT $DayName($GetUTCDate($TimeSecs))
See Also
$adddays
$addmonths
$addweeks
$addyears
$day
$dayname
$month
$monthname
$Time
$TimeSecs
$weekday
$year
About Data Types
System Variables
The logical width of the current window in columns.
Syntax
$window pswidth
Return Value
A number. Cannot be reset by an application program.
Description
The logical width of the current window in character columns.
The $WindowPSWidth function is reset when the current window changes.
See Also
ThisWindow
WINDOW SET CURRENT
WINDOW SET OUTPUT
The logical height of the current window in rows.
Syntax
$windowpsheight
Return Value
A number. Cannot be reset by an application program.
Description
The logical height of the current window in character rows.
The $WindowPSHeight function is reset when the current window changes.
See Also
ThisWindow
WINDOW SET CURRENT
WINDOW SET OUTPUT
Indicates if the application user has pressed the “break” key.
Syntax
$breakflag
Return Value
Binary. Can be reset by an application program.
Description
At the start of an application session, $BreakFlag is set to “0” ($False). Set to “1” ($True) if the application user presses the “break” key. The application program must reset the variable to “0” ($False) to be able to detect subsequent user interrupts.
See Also
About Conditional Expressions
SET BREAKABLE
System Variables
The number of records processed by the most recent set-processing command.
Syntax
$membercount
Return Value
A number. Can be reset by an application program.
Description
The number of records processed by the most recent set-processing command.
See Also
ADD
CHANGE
COMPUTE
DELETE
FIND
INSERT
LIST
REPORT FROM
SELECT
SORT
UPDATE
System Variables
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.