$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.

Provides the failure error code returned by a component function.

Syntax

$ObjErrCode

Return Value

Number (LONGINT). Can be reset by an application program.

Comments

The variable gives the failure error code returned by a component function. This variable is set to $null when a component operation triggers a Zim error and is set to a meaningful value when a Zim 5207 error is encountered.

Warning

COM objects are being discontinued by Microsoft and may not be available in future releases of Zim-X.

Clears the contents of the current window.

Syntax

CLEAR

See Also

FORM DISPLAY

SCREEN CLEAR

WINDOW CLEAR

Destroy an ActiveX object.

Syntax

$ObjDestroy (Object)

Parameters

Return Value

Returns a boolean; TRUE if the object was destroyed.

In Zim 7.1, setting an object to $Null will also destroy it.  This is the preferred method of releasing an object.  For example:

Let MyObj = $Null

Instead of

$ ObjDestroy(MyObj)

Warning

COM objects are being discontinued by Microsoft and may not be available in future releases of Zim-X.

Explains the most likely cause of the last error to occur during the application session.

Syntax

EXPLERR

See Also

$ErrCode

$LastErrCode

$LastErrMessage

DESCERR

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.

Provides the name of the ActiveX object that triggered an exception.

Syntax

$ObjErrObjectType

Return Value

Character string (VARALPHA). Can be reset by an application program.

Comments

The variable gives the name of the ActiveX object that triggered an exception in the component. This variable is set to $null when a component operation triggers a Zim error but is set to a meaningful value when a Zim 5207 error is generated.

Warning

COM objects are being discontinued by Microsoft and may not be available in future releases of Zim-X.

Provides a description of the error that triggered an exception.

Syntax

$ObjErrDescription

Return Value

Character string (VARALPHA). Can be reset by an application program.

Comments

The variable gives a meaningful description of the error that triggered an exception in the component. This variable is set to $null when a component operation triggers a Zim error but is set to a meaningful value when a Zim 5207 error is encountered.

Warning

COM objects are being discontinued by Microsoft and may not be available in future releases of Zim-X.

Calculates the arccosine of a number.

Syntax

$acos(number)

where

Return Value

Number, with the same number of decimal places as number.

Comments

Use $acos to calculate the arccosine (in radians) of a number. The value returned by this function has the same number of decimal places as number. The absolute value of the number must be between 0 and 1.

Example

let vAngle[3] = $acos(0.500)

The preceding command sets the third element of array variable vAngle to 1.047.