$DBCharSet

Indicates the character set used by the application database.

Syntax

$dbcharset

Return Value

2 for ANSI or 3 for UTF-8, depending on the character set specified when the database was initialized. Cannot be reset by an application program.

Description

When you initialize a new application database, the database (ZIMBOOT) administrative utility requires you to specify the character set to be used. Once the database has been initialized, the character set cannot be changed.
During an application session, the $DBCharSet system variable contains the name of the character set used by the current application database.

Example

ANSI is a Zim constant with a value of 2, so you could use the following:

if $DBCharSet = ANSI
...
endif

See Also

SET DOCUMENT FORMAT

$Graphics

The name of a graphics software package.

Syntax

$graphics

Return Value

A character string. Can be reset by an application program.

Description

Set by the application program to the name of a graphics program.

$Graphics can be set to the name of a graphics program of your choosing. The name should include the full disk path. The special file path indicator characters can be used.

The GRAPH command automatically calls up the program named in the $Graphics system variable.

When running ZimTC, the following code will simply copy the “xxx.zzz” to the client side without executing any further actions:

let $graphics = ""
graph "xxx.zzz"

Example

let $graphics = "c:chartappchart.exe"

See Also

$ClipPath

$DBPath

$Editor

$ImagePath

$WorkPath

$ZimPath

About Character Literals

GRAPH

System Variables

$direction

Indicates the direction in which focus was moving when an event occurs.

Syntax

$direction

Return Value

A number (-1, 0, or +1.) Can be reset by an application program.

Description

The direction of travel of focus when an event occurred.

ValueMeaning
-1“Backward” direction. The focus was moving backward (with respect to the current TABORDER) when an event occurred.
0No direction. The focus is not moving.
+1“Forward” direction. The focus was moving forward (with respect to the current TABORDER) when an event occurred.

See Also

FORM INPUT

MENU INPUT

System Variables

WINDOW SET

$BreakFlag

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

$True

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

$TimeSecs

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

en_CAEnglish