ONKEY 関数

目的

アクセスしているファイルに対する入出力操作時に条件の通知の原因となったキー値を返します。

構文

ONKEY()

説明

ONKEY 関数は、キーでアクセスしているファイルに対する入出力操作時に KEY 条件の通知の原因となったキー値を返します。

ONKEY 関数は、ENDFILE、KEY、RECORD、および UNDEFINEDFILE 条件のために確立された ON-unit において使用できます。また、KEY 条件に対する Open PL/I のデフォルトのアクションの結果として制御を取得する ERROR ON-unit でも使用できます(デフォルトのアクションでは ERROR 条件が通知されます)。

戻り値は可変長の文字列です。

例

ON KEY(DFILE) BEGIN;
 PUTEDIT ('DFILE KEY',ONKEY(),'NOT FOUND')(SKIP,3 A); 
END;

制約事項

ON-unit 以外で参照されている場合やキーでアクセスしているファイルに関連しない条件の結果として実行される ON-unit 内で参照されている場合、ONKEY 関数は null 文字列を返します。