4.2.5　CBLXML-WR-Interface-BaseElementアクセスルーチン

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

形式

CALL 'CBLXML-WR-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-WR-Interface-BaseElementアクセスルーチンが回復可能エラー（ステータス1〜99）を返した場合，XMLドキュメントの出力を続行できます。

• CBLXML-WR-Interface-BaseElementアクセスルーチンが致命的エラー（ステータス100〜199）を返した場合，それ以上XMLドキュメントの出力を続行できません。

  エラーが発生したXMLドキュメントに対しては，CBLXML-CL-Interfaceアクセスルーチン，またはCBLXML-CN-Interfaceアクセスルーチンだけが実行できます。それ以外のアクセスルーチンを実行した場合，動作は保証しません。

• CBLXML-WR-Interface-BaseElementアクセスルーチンがエラーを返しても，XMLドキュメントは閉じられません。必ずCBLXML-CL-Interfaceアクセスルーチン，またはCBLXML-CN-Interfaceアクセスルーチンを実行してXMLドキュメントを閉じてください。CBLXML-WR-Interface-BaseElementアクセスルーチンが回復可能エラー，または致命的エラーを返した場合，不完全なXMLドキュメントが生成される可能性があります。

• 出力，更新した場合のXMLドキュメントの文字エンコーディングは，「付録G.1(1)　出力するXMLドキュメントの文字エンコーディングの設定」に従って出力されます。更新機能を使用する場合，開いたXMLドキュメントの文字エンコーディングではなく，出力するXMLドキュメントの文字エンコーディングの設定に従って変更されます。

• 更新モードで開いたXMLドキュメントに対応するDDFファイルで，update属性に"yes"を指定していない場合，CBLXML-WR-Interface-BaseElementアクセスルーチンは，XMLドキュメントを更新できないことを示すステータス13を返します。

• 更新モードで開いたXMLドキュメントから入力をしないで出力した場合，ステータス15が返ります。

• 更新モードで開いたXMLドキュメントで，直前の入力に対して異なるBaseElement属性で出力した場合，ステータス15が返ります。