LabWindows/CVI

CVIXMLGetAttributeByIndex

CVIXMLStatus CVIXMLGetAttributeByIndex (CVIXMLElement element, int index, CVIXMLAttribute *attribute);

Purpose

Gets an element's attribute at the specified position. If the attribute does not exist at the index, the function returns an error.

Parameters

Input
Name Type Description
element CVIXMLElement The element handle must be a valid CVIXMLElement.
index int The zero-based index where the attribute is located under the parent element. Pass –1 to get the last attribute.
Output
Name Type Description
attribute CVIXMLAttribute On output, contains the handle to the attribute object obtained in this function. If the attribute does not exist at the index, this function returns an error. This handle must be discarded using the CVIXMLDiscardAttribute 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

Examples

Refer to the following examples that use the CVIXMLGetAttributeByIndex function:

  • apps\xmlTree\xmlTree.cws

    Open example
  • toolbox\XMLSample.cws

    Open example

Log in to get a better experience