$ImagePath

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.

$ClipPath

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.

$ZimPath

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.

$ZimOS

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.

 

ValueOperating System
3All Linux Flavours
11Microsoft Windows
12Linux Running on Android

$SQLErrCode

The error code returned from the SQL database.

Syntax

$sqlerrcode

Value

A number. Can be reset by an application program.

Description

A numeric code returned from the SQL database for the last SQL statement executed. For explanation of these error codes, consult the documentation for the particular SQL server.

See Also

$SQLErrMsg

System Variables

$Located

Indicates the number of records that meet the condition(s) specified in the most recent LOCATE command.

Syntax

$located

Return Value

A number. Can be reset by an application program.

Description

The number of records that met the conditions specified in the most recent LOCATE command.

See Also

LOCATE

System Variables

$LineNumber

Syntax

$LineNumber

Return Value

The line number (int) of the current command in the currently executing program. It cannot be reset by an application program.

Comments

For commands that are continued over more than one line, $LineNumber refers to the last line of the command.

See Also

SET LEXTRACE

SET TRACE

$SQLErrMsg

The error message returned from the SQL database.

Syntax

$sqlerrmsg

Value

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

Description

A character string, containing the message returned from the SQL database for the last SQL statement executed. For explanation of these error messages, consult the documentation for the particular SQL server.

See Also

$SQLErrCode

REMOTEEXEC

pt_BRPortuguese