$SUBSTR（部分文字列抽出関数）

指定した文字列、抽出開始位置および文字列の長さの定義に従って、部分的に文字列を抽出します。

〈このページの構成〉

形式

返却値=$SUBSTR(処理対象文字列,抽出開始位置,抽出する文字列の長さ)

返却値

部分抽出した文字列を設定する変数名を指定します。
処理対象文字列

抽出の対象となる文字列を定数または変数で指定します。定数を指定する場合は、「'（シングルクォーテーション）」で囲みます。
抽出開始位置

処理対象文字列の先頭文字を0として、抽出を開始する位置を定数または変数で指定します。定数を指定する場合は、「'（シングルクォーテーション）」で囲みます。

抽出開始位置には、0以上の値を指定してください。存在しない抽出開始位置を指定した場合、0バイトの文字列を返します。
抽出する文字列の長さ

抽出する部分の文字列の長さ（バイト数）を定数または変数で指定します。処理対象文字列の長さを超えて指定した場合、処理対象文字列の長さまでが有効となります。なお、抽出開始位置から最後の文字列をすべて指定する場合は、負数を指定します。

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

「NAME」に文字列「ABCDEFG」が格納されている場合、結果として「VALUE」に「ABC」が抽出される記述例を次に示します。

[SET_VALUE]
  NAME = ‘ABCDEFG’
  VALUE=$SUBSTR(NAME,0,3)
  $ECHO(VALUE)