Get the root node.

Syntax

XML_Node *XML_GetRootNode(
  XML_HANDLE hXml,
  int *ErrCode
);

Parameters

hXml
[in] XML handle
ErrCode
[out] A pointer to a variable that returns an error code. Specify NULL when no error code is required.

Return value

Returns a pointer to the XML_Node structure if the function succeeds, otherwise NULL.

Remarks

Returns a pointer to the XML_Node structure of the root node.

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

Error codeDescription
XML_INVALID_PARAMETER_ERRORParameter error
XML_INVALID_XML_OBJECT_ERRORInvalid XML handle

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