$ErrCode

The error code generated by the last command executed.

Syntax

$errcode

Return Value

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

Description

Indicator of success (0) or a reason (1 to 9999) for the failure of the most recently executed command.

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

$ErrLevel

$LastErrLevel

$LastErrMessage

$MaxErrLevel

System Variables

$exp

Calculates an exponential value of the natural base (e).

Syntax

$exp(number)

Parameters

numbera number or an expression that evaluates to a number

Return Value

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

Example

$exp(2.000)

The above expression means “the natural base e, squared” and evaluates to 7.389.

See Also

$log

$log10

$sqrt

About Functional Expressions

$ZimSeqNum

Returns the last Automatic Sequence Number applied.

Syntax

$ ZimSeqNum

Return Value

Number, representing an Automatic Sequence Number or $Null in case of an error.

Comments

The value returned by $ ZimSeqNum is taken from the most recent ASN used. Notice that when the ADD command adds more than one record, $ ZimSeqNum will contain the value of the last record added.

$ ZimSeqNum also returns the number set using SET SEQUENCENUMBER MyEnt . Upon execution of  SET SEQUENCENUMBER MyEnt ON, $ZimSeqNum returns the next number available. The $ZimSeqNum result after executing SET SEQUENCENUMBER ALL ON is undefined.

Example

If all ADD statements refer to objects that contain ASN, the $ZimSeqNum will return the value taken by the last ADD:

ADD 1 Customers ...
ADD 100 MyEnt from MyDoc ...
output $ZimSeqNum

SET EOLNTRANSLATE

Translates carriage return/line feed sequences.

Syntax

SET EOLNTRANSLATE string

Parameters

string

Any expression that evaluates to a character string from one to five characters in length. If string is longer than five characters, only the first five characters are used.

Comments

If the software encounters a carriage return/line feed combination in a database field when outputting that field to an application document, the carriage return/line feed combination is substituted for string. If the software encounters string during a read of an application document, the string generates a carriage return/line feed combination.

In operations that write data to an application document, the software substitutes the specified EOLTRANSLATE string for each carriage return/line feed sequence detected in the output from a single field. In operations that read data from an application document, the software substitutes a carriage return/line feed sequence for each EOLTRANSLATE string it detects in a single field.

$addhours

$addhours

Calculates a time value by adding hours to (or subtracting hours from) a specified time value.

Syntax

$addhours(time,number)

where

timean 8-digit number, or an expression that evaluates to an 8-digit number, that expresses a valid time value in the format HHMMSSTT
numbera number, or an expression that evaluates to a number

Return Value

Number, representing a time value.

Comments

Use $addhours to perform arithmetic with time values. The $addhours function calculates a time value by adding a number representing hours to a time value. If number is negative, the effect is to subtract the hours from the time.

Example

If $Time has the value 22503075, then

$addhours($time,1)

Evaluates to 23503075.

$addhours($time,2)

Evaluates to 00503075.

$addhours($time,-3)

Evaluates to 19503075.

$RightClickMenu

The function $RightClickMenu displays a right-click menu at the location of the last right click or at (0,0) if none has occurred. It has the following syntax:

$RightClickMenu ("ListOfMenuItems")

where ListOfMenuItems is a string composed of menu item strings separated by semicolons. The menu separator is a valid menu item and is identified by one dash or minus sign “-“.
$RightClickMenu returns a string that identifies the chosen menu item or a null string if no item was chosen. The $RightClickMenu is limited to entries 31 bytes in length.

Example

$RightClickMenu ("Line 1;Line number 2;-;Another Line;Yet Another Line;")

$sqrt

Calculates the square root of a number.

Syntax

$sqrt(number)

Parameters

numbera positive number or an expression that evaluates to a positive number

Return Value

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

Example

$sqrt (100)

The above expression means “the square root (in base 10) of 100” and evaluates to 10.

See Also

$absolute

$exp

$log

$log10

About Functional Expressions

en_CAEnglish