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