Syntax
bool XML_DeleteNode(
XML_HANDLE hXml,
XML_Node *node,
bool delete_child_node,
int *ErrCode
);
Parameters
- hXml
- [in] XML handle
- node
- [in] A pointer to the XML_Node structure of the node.
- delete_child_node
- [in] If true is specified, the child nodes of the specified node will also be deleted.
- ErrCode
- [out] A pointer to a variable that returns an error code. Specify NULL when no error code is required.
Return value
Returns true if the function succeeds, false otherwise.Remarks
Deletes the specified node.
If true is specified for delete_child_node, the child nodes of the specified node will also be deleted.
If false is specified for delete_child_node, the function fails if the specified node has a child node, and ErrCode returns the following error code.
| Error code | Description |
|---|---|
| XML_DELETE_NODE_ERROR | The node could not be deleted. |
If the specified node is the root node, the function fails and ErrCode returns the following error code.
| Error code | Description |
|---|---|
| XML_DELETE_NODE_ERROR | The node could not be deleted. |
If the function fails, it returns false and ErrCode returns the following error code:
| Error code | Description |
|---|---|
| XML_INVALID_PARAMETER_ERROR | Parameter error |
| XML_INVALID_XML_OBJECT_ERROR | Invalid XML handle |
| XML_INVALID_NODE_OBJECT_ERROR | Invalid node is specified. |
| XML_DELETE_NODE_ERROR | The node could not be deleted. |
Requirements
Header file:
XML.hLibrary file:
CodeConversion.h : ver. 1.1.1 or later.
libXML.a
libCodeConversion.a : ver.1.1.1 or later
libSTARTUPOPH5000.a
See also
Last updated: 2021/10/21