Deletes attributes of the specified node.

Syntax

bool XML_DeleteAttributes(
  XML_HANDLE hXml,
  XML_Node *node,
  const char *name,
  int *ErrCode
);

Parameters

hXml
[in] XML handle
node
[in] A pointer to the XML_Node structure of the node.
name
[in] A pointer to a string that specifies the name of the attribute. If NULL is specified, all attributes of the specified node will 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 attribute with the specified name from the attributes of the specified node.

Specifying NULL for name deletes all attributes of the specified node.

If the function fails, it returns false and ErrCode returns the following error code:

Error codeDescription
XML_INVALID_PARAMETER_ERRORParameter error
XML_INVALID_XML_OBJECT_ERRORInvalid XML handle
XML_INVALID_NODE_OBJECT_ERRORInvalid node is specified.
XML_NOT_FOUNDThe attribute to delete was not found.

Requirements

Header file:
XML.h
CodeConversion.h : ver. 1.1.1 or later.
Library file:
libXML.a
libCodeConversion.a : ver.1.1.1 or later
libSTARTUPOPH5000.a

See also

Last updated: 2021/10/21