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