The name of the text editor software for editing programs.

Syntax

$editor

Return Value

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

Description

The name of a text editor.

Each time you start a new application session, $Editor is set, by default, to the name of an editor commonly used on the current operating system, or to the value of the editor in the registry. The variable is often reset by the application program to the name of the preferred text editing package.

Since Zim-X 9.50, the default editor is set to “IDE”.

The name should include the full disk path, if necessary. The special file path indicator characters can be used.

The value of this variable is used by the EDIT command.

Example

let $editor = "c:dosedit.com"

See Also

EDIT

The current user’s operating system group ID.

Syntax

$groupid

Return Value

A character string, or $Null. Cannot be reset by an application program.

Description

The current user’s operating system group ID (if the operating system supports group IDs); otherwise, $Null.

You can use the $UserID and $GroupID system variables to build levels of security into your applications.

During a Zim session, you also can LOGIN to the software under any defined UserName (in EntitySet Users). $ZUserID and $ZGroupID are then set to the UserID and GroupID associated with UserName; $UserID and $GroupID (containing values taken from the operating system) are still available for use.

See Also

$UserID

$ZGroupID

$ZUserID

System Variables

$ZUserID

The application user’s Zim user identifier.

Syntax

$zuserid

Return Value

The user identifier of the user specified in the last successful LOGIN command. Cannot be reset by an application program.

Description

Upon successful execution of a LOGIN command, $ZUserID is set to the specified user’s ID.

Although you can change the value of this variable, you cannot change the effect of the LOGIN command. The software continues to treat the current user according to the GroupID and UserID associated with the UserName given in the last LOGIN command.

When you call up any Zim system (full, Runtime, etc.), the software automatically attempts to log you in as a user called ZIM.

See Also

$GroupID

$UserID

About Character Literals

LOGIN

System Variables

The error code generated by the last command that returned an error code.

Syntax

$lasterrcode

Return Value

A number (1 to 9999). Can be reset by an application program.

Description

The reason for the failure of the most recently executed command that returned an error code other than 0 (success)

At the beginning of each application session, $LastErrCode is set to $Null. Its value then changes only if a command returns an error code, or the application program explicitly assigns it a new value.

Explanations for many error codes are contained in the ErrorHelp entity set, which you can access from your database application using the DESCERR or EXPLERR utility program.

See Also

$ErrCode

$ErrLevel

$LastErrLevel

$LastErrMessage

$MaxErrLevel

System Variables

The highest error severity level generated during the application session.

Syntax

$maxerrlevel

Value

A number (0 to 4). Can be reset by an application program.

Description

The highest error severity level encountered to the current point in the application session.

See Also

$ErrCode

$ErrLevel

$LastErrLevel

$LastErrMessage

System Variables

The location of focus in a window when an event occurs.

Syntax

$cursorrow

Return Value

A number which is the row location for focus of the current window at the time of an event. Can be reset by an application program.

Description

The number of the character row where focus was located within the current window at the time of an event . If focus is on an entry field, $CursorRow gives the position of the text cursor.

Example

To output the row and column position of focus in window wMain when an event occurs:

window open wMain
form open Form1
form display input
output $cursorrow $cursorcol

See Also

$CursorCol

$CursorScreenCol

$CursorScreenRow

CURSOR

FORM INPUT

System Variables

The application user’s Zim group identifier.

Syntax

$zgroupid

Return Value

The group identifier of the user specified in the last successfully executed LOGIN command. Cannot be reset by an application program.

Description

Upon successful execution of a LOGIN command, $ZGroupID is set to the specified user’s group identifier.

Although you can change the value of this variable, you cannot change the effect of the LOGIN command. The current user continues to be treated according to the GroupID and UserID associated with the UserName given in the last LOGIN command.

When you call up any Zim system (full, Runtime, etc.), the software automatically attempts to log you in as a user called ZIM.

See Also

$GroupID

$UserID

$ZUserID

The location of focus in a window when an event occurs.

Syntax

$cursorcol

Return Value

A number which is the column location for focus of the current window at the time of an event. Can be reset by an application program.

Description

The number of the character column where focus was located within the current window at the time of an event. If focus is on an entry field, $CursorCol gives the position of the text cursor.

Example

To output the row and column position of focus in the current window when an event occurs:

window open wMain
form open Form1
form display input
output $cursorrow $cursorcol

See Also

$CursorRow

$CursorScreenCol

$CursorScreenRow

CURSOR

FORM INPUT

MENU INPUT

System Variables

The error severity level generated by the last command executed.

Syntax

$errlevel

Value

A number (0 to 4.) Can be reset by an application program.

Description

The error severity level of the most recently executed command.

See Also

$ErrCode

$LastErrLevel

$MaxErrLevel

System Variables

Indicates the Zim:X product currently being used.

Syntax

$zimproduct

Return Value

A number according to the description below. Cannot be reset by an application program.

Description

See Also

$ZimOS
$ZimVersion