指定のノードを削除します。

構文

bool XML_DeleteNode(
  XML_HANDLE hXml,
  XML_Node *node,
  bool delete_child_node,
  int *ErrCode
);

パラメータ

hXml
[in] XMLハンドル
node
[in] ノードのXML_Node構造体を指すポインタ。
delete_child_node
[in] trueを指定すると、指定のノードの子ノードも削除します。
ErrCode
[out] エラーコードを返す変数を指すポインタ。エラーコードが不要のときはNULLを指定します。

戻り値

 関数が成功したらtrueを、それ以外はfalseを返します。

解説

 指定されたノードを削除します。

 delete_child_nodeにtrueを指定すると、指定されたノードの子ノードも削除します。

 delete_child_nodeにfalseを指定すると、指定されたノードに子ノードがあったときは関数が失敗し、ErrCodeに次のエラーコードを返します。

エラーコード説明
XML_DELETE_NODE_ERRORノードを削除できなかった。

 指定されたノードがルートノードのときは関数が失敗し、ErrCodeに次のエラーコードを返します。

エラーコード説明
XML_DELETE_NODE_ERRORノードを削除できなかった。

 関数が失敗したときはfalseを返し、ErrCodeには次のエラーコードを返します。

エラーコード説明
XML_INVALID_PARAMETER_ERRORパラメーターエラー
XML_INVALID_XML_OBJECT_ERROR不正なXMLハンドルが指定された。
XML_INVALID_NODE_OBJECT_ERROR不正なノードが指定された。
XML_DELETE_NODE_ERRORノードを削除できなかった。

必要条件

ヘッダファイル:
XML.h
CodeConversion.h : ver.1.1.1以降
ライブラリファイル:
libXML.a
libCodeConversion.a : ver.1.1.1以降
libSTARTUPOPH5000.a

関連事項

最終更新日:2021/10/21