The name of the database as provided in the connection.
Syntax
$dbname
Return Value
A character string. Cannot be reset by an application program.
Description
The $DBName function is set to the value of the database name provided as a connection parameter.
See Also
$DBPath
The file system path for the Zim Server Access Modules (SAM).
Syntax
$sqlpath
Value
The pathname of the directory pointed to by the SQLCPI variable.
Description
The SQLCPI variable is defined in the registry. The SQLCPI variable indicates the directory containing the Zim Server Access Modules.
The field number of the current form field.
Syntax
$fieldnum
Return Value
A number. ZIM sets the $FieldNum to the field number (FNum) of the form field in which the cursor is located when FORM INPUT terminates.
Comments
The combination of $FormNum, $Subscript and $FieldNum can uniquely identify a particular form field in a Zim display.
The current instance of the current form
Syntax
$subscript n
Parameters
| n | Any numeric value between 1 and 8 |
Comments
In combination of $FormNum, $subscript, $ FieldNum can uniquely identify a particular for field in a Zim display.
Example
form set (reverse) ($ formnum,$ fieldnum,$subscript)
Sets the current instance of a repeated form to reverse video.
find Products where ProdCode = fProducts.ProdCode [$subscript]
Finds all product records that match the product code on the current instance of the repeated form fProducts.
Returns a cryptographic 128-bit hash value.
Syntax
$md5(expression)
Parameters
| expression | an expression that evaluates to a string |
Return Value
The value returned by $MD5 is a hexadecimal 32-characters long string representing the cryptographic hash value of the expression used as the argument.
Example
out $md5(1)
45954632C04A953592D33FDC5F59A64C
out $md5("1")C4CA4238A0B923820DCC509A6F75849B
The returned values are different because the $md5(1) first converts the number 1 to a character string (which becomes ” 1″) and then applies the MD5 algorithm to it.
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.
Destroy an ActiveX object.
Syntax
$ObjDestroy (Object)
Parameters
| Object | a component object variable or formfield of type OLE |
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.
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
| number | a number, or an expression that evaluates to a number |
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.