CVIXMLGetRootElement
- Updated2023-02-21
- 1 minute(s) read
CVIXMLStatus CVIXMLGetRootElement (CVIXMLDocument document, CVIXMLElement *element);
Purpose
Gets the root element of an XML document. The root element of a document is the main element of the document, in which all other elements are contained.
Parameters
| Input | ||
| Name | Type | Description |
| document | CVIXMLDocument | The document handle must be a valid CVIXMLDocument. |
| Output | ||
| Name | Type | Description |
| element | CVIXMLElement | On output, contains the handle to the root element object obtained in this function. This handle must be discarded using the CVIXMLDiscardElement function. |
Return Value
| Name | Type | Description | ||||
| status | CVIXMLStatus | Indicates whether the function was successful. A zero indicates success. You can call CVIXMLGetErrorString to obtain textual descriptions of error codes. Among the more commonly encountered errors are:
|
Additional Information
Library: CVIXML
Include file: toolbox\cvixml.h
LabWindows/CVI compatibility: LabWindows/CVI 7.0 and later
Examples
Refer to the following examples that use the CVIXMLGetRootElement function:
- apps\xmlTree\xmlTree.cws
Open example - toolbox\XMLSample.cws
Open example