$log

Return the natural logarithm of X (log e X).

$log(X)

Parameters

X—positive numeric constant, or a field (or indirect reference to a field), variable, function, or expression that evaluates to a positive numeric value. X must be in the range 0 through 10 9999 .

Return Values

Natural logarithm of X

If an error occurs, $procerror contains a negative value that identifies the exact error.

Values of $procerror Commonly Returned Following $log and $log10.
Value  Error constant Meaning
-1204 <UPROCERR_NEGATIVE> Negative value not allowed.
-1205 <UPROCERR_ZERO> Zero value not allowed.

Use

Allowed in all component types.

Description

The $log function returns the natural logarithm of X (that is, log e X).

Using $log

The following example returns the natural logarithm of the given expression:

vLogarithm = $log(MYFIELD * 2)

Related Topics