LabWindows/CVI

CVIXMLGetParentElement

CVIXMLStatus CVIXMLGetParentElement (CVIXMLElement element, CVIXMLElement *parentElement);

Purpose

Gets the parent of this element.

Parameters

Input
Name Type Description
element CVIXMLElement The element handle must be a valid CVIXMLElement.
Output
Name Type Description
parentElement CVIXMLElement On output, contains the handle to the element object obtained in this function. If the input element is the root element in the XML document, the output value is 0. 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:

E_OUTOFMEMORY Out of memory.
E_INVALIDARG Invalid argument to a function.

Additional Information

Library: CVIXML

Include file: toolbox\cvixml.h

LabWindows/CVI compatibility: LabWindows/CVI 7.0 and later

Example

Refer to toolbox\XMLSample.cws for an example of using the CVIXMLGetParentElement function.