$GETKEYFROMARRAY(キー情報の取得関数)
キー付きで配列に格納されている情報から、指定した配列番号のキー情報を取得します。
形式
返却値=$GETKEYFROMARRAY(配列変数名,配列番号)
指定する値
-
返却値
取得したキーを設定する変数名を指定します。
-
配列変数名
キー情報を取り出す配列変数の変数名を指定します。
-
配列番号
数字、定数または変数を指定します。定数を指定する場合は、「'(シングルクォーテーション)」で囲みます。数字に指定できる範囲は1〜2,147,483,647です。
指定した配列番号の配列要素がない場合は、0バイトの文字列を返します。
終了状態
処理の終了状態とその内容を次に示します。
終了状態 |
内容 |
---|---|
NORMAL |
正常終了 |
NODATA |
指定した配列番号の情報が存在しない |
ERROR |
− |
スクリプト中断 |
引数の誤り、またはそのほかのエラー |
- (凡例)
-
−:該当しない
記述例
配列変数「ARY」の5番目のキー情報および値を取得する場合の記述例を次に示します。
[SET_VALUE] $CLEARARRAY(ARY) $SETARRAYBYKEY(ARY,'CPU','100') # ARY[1] CPU[1] $SETARRAYBYKEY(ARY,'CPU','200') # ARY[2] CPU[2] $SETARRAYBYKEY(ARY,'HD' ,'40') # ARY[3] HD[1] $SETARRAYBYKEY(ARY,'HD' ,'20') # ARY[4] HD[2] $SETARRAYBYKEY(ARY,'MEM','128') # ARY[5] MEM[1] $SETARRAYBYKEY(ARY,'MEM','256') # ARY[6] MEM[2] KEY = $GETKEYFROMARRAY(ARY,5) VAL = $GETARRAY(ARY, 5) MSG = 'ARY[5]: KEY=' +KEY+ ' VAL=' +VAL $ECHO(MSG)
- 実行結果
-
ARY[5]: KEY=MEM VAL=128