4.2.4 CBLXML-RD-Interface-BaseElementアクセスルーチン

CBLXML-RD-Interface-BaseElementアクセスルーチンは,DDFのBaseElement要素に指定したXML要素の単位でデータの読み込みを実行します。1回のアクセスルーチンの呼び出しで,DDFのItem要素に対応するすべての要素のデータが読み込まれ,XMLアクセス用データ定義に格納されます。

形式

CALL 'CBLXML-RD-Interface-BaseElement'
               USING XML-POINTER
                     XMLアクセス用データ定義
               RETURNING CBLXML-RETURN-CODE.

引数
引数のデータ型指定説明
01 XML-POINTER
USAGE POINTER.
データを読み込むXMLドキュメントのポインタを指定する。CBLXML-OP-Interfaceアクセスルーチン,またはCBLXML-OB-InterfaceアクセスルーチンでXMLドキュメントを開いたときに取得したポインタを指定する。
XMLアクセス用データ定義cblxmlコマンドで生成されたXMLアクセス用データ定義のデータ項目名を指定する。このデータ項目に,読み込まれたデータが格納される。
01 CBLXML-RETURN-CODE
PIC 9(9) COMP.
ステータスが返される。詳細については,「7.3 XMLアクセスルーチンが返すステータス」を参照のこと。
(凡例)
○:アクセスルーチンの呼び出し時,値を設定しておく項目
△:アクセスルーチンの完了時,値が設定される項目
規則
  • 引数XML-POINTERには,CBLXML-OP-Interfaceアクセスルーチン,またはCBLXML-OB-InterfaceアクセスルーチンでXMLドキュメントを開いたときに取得したポインタを指定します。
  • CBLXML-RD-Interface-BaseElementアクセスルーチンが回復可能エラー(ステータス1~99)を返した場合,XMLドキュメントの入力を続行できます。
  • CBLXML-RD-Interface-BaseElementアクセスルーチンが致命的エラー(ステータス100~199)を返した場合,それ以上XMLドキュメントの入力を続行できません。
    エラーが発生したXMLドキュメントに対しては,CBLXML-CL-Interfaceアクセスルーチンだけが実行できます。それ以外のアクセスルーチンを実行した場合,動作は保証しません。
  • CBLXML-RD-Interface-BaseElementアクセスルーチンがエラーを返しても,XMLドキュメントは閉じられません。必ずCBLXML-CL-Interfaceアクセスルーチン,またはCBLXML-CN-Interfaceアクセスルーチンを実行してXMLドキュメントを閉じてください。