$MOD (divide and return only the remainder)

$MOD performs division, treating character strings as numeric values, and returns the remainder of the arithmetic result.

Organization of this page

Syntax
Values
Status
Remarks
Example

Syntax

return-value=$MOD(character-string,numeric-character)

To Page Top

Values

return-value

Specifies the name of the variable into which the arithmetic result is set. Valid results range from 0.0001 to 999,999,999,999,999 (15 digits). If the result is outside the valid range, 0 is assumed.
character-string

Specifies a dividend, either as a constant or a variable. A constant must be enclosed in single quotation marks (''). Specified values can range from 0.0001 to 999,999,999,999,999 (15 digits).
numeric-character

Specifies a divisor, either as a constant or a variable. A numeric value specified as a constant that includes a decimal point must be enclosed in single quotation marks (''). Specified values can range from 0.0001 to 999,999,999,999,999 (15 digits). If 0 is specified, 0 is returned to return-value.

To Page Top

Status

The following table lists and describes the possible statuses:

Status	Description
`NORMAL`	Normal end
`NODATA`	Indicates one of the following: An invalid value was specified in a character string or numeric value. The arithmetic result is a value outside the range of representable values.
`ERROR`	—
Script execution interrupted	An invalid argument was specified, or an error other than the above occurred.

Legend:: —: Not applicable

To Page Top

Remarks

If a value that cannot be specified in character-string or numeric-character is encountered, or if the arithmetic result is a value outside the representable range, 0 is returned to return-value.

To Page Top

Example

The following example calculates 10 ÷ 3 and outputs the remainder:

[SET_VALUE]
  VAL1 = 10
  VAL2 = $MOD(VAL1, 3)
 
  MSG = 'MOD: ' +VAL1+ ' MOD 3 = ' +VAL2
  $ECHO(MSG)

Execution result:: MOD: 10 MOD 3 = 1

To Page Top