$MOD（除算結果の余りの取得関数）

文字列を数値と見なして除算を実行し、その演算結果の余りを返します。

〈このページの構成〉

形式

返却値=$MOD(文字列,数字)

返却値

演算結果を設定する変数名を指定します。結果として取得できる値の範囲は、0.0001〜999,999,999,999,999（15けた）です。結果が範囲外となった場合は0を返します。
文字列

被除数を定数または変数で指定します。定数を指定する場合は、「'（シングルクォーテーション）」で囲みます。指定できる値の範囲は、0.0001〜999,999,999,999,999（15けた）です。
数字

除数を定数または変数で指定します。小数点を含む数値を定数で指定する場合は、「'（シングルクォーテーション）」で囲みます。指定できる値の範囲は、0.0001〜999,999,999,999,999（15けた）です。0を指定した場合は、返却値に0が返されます。

処理の終了状態とその内容を次に示します。

終了状態	内容
NORMAL	正常終了
NODATA	次のどちらかを示す文字列または数値に指定した値に誤りがある演算結果が表現できる値の範囲外
ERROR	−
スクリプト中断	引数の誤り、またはそのほかのエラー

「文字列」、「数字」に指定できない値が指定されている場合、および演算結果が表現できる範囲外となった場合は、返却値には0が返されます。

「10÷3」を演算し、余りを出力する場合の記述例を次に示します。

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