$GETARRAY(配列からのデータ取得関数)
配列に格納されている情報から、指定した配列番号の情報を取得します。
形式
返却値=$GETARRAY(配列変数名,配列番号)
指定する値
-
返却値
取得した情報を設定する変数名を指定します。
-
配列変数名
情報を取り出す対象の配列の変数名を指定します。
-
配列番号
情報を取り出す配列要素の配列番号を、定数または変数で指定します。定数を指定する場合は、「'(シングルクォーテーション)」で囲みます。指定できる値の範囲は1〜2,147,483,647です。
指定した配列番号の配列要素がない場合は、0バイトの文字列を返します。
終了状態
処理の終了状態とその内容を次に示します。
終了状態 |
内容 |
---|---|
NORMAL |
正常終了 |
NODATA |
指定した配列番号の情報が存在しない |
ERROR |
− |
スクリプト中断 |
引数の誤り、またはそのほかのエラー |
- (凡例)
-
−:該当しない
記述例
$SETARRAY(配列へのデータ設定関数)の記述例を参照してください。