LabWindows/CVI

CVIXMLGetAttributeByName

CVIXMLStatus CVIXMLGetAttributeByName (CVIXMLElement element, char *name, CVIXMLAttribute *attribute);

Purpose

Gets an element's attribute by its name.

Parameters

Input
Name Type Description
element CVIXMLElement The element handle must be a valid CVIXMLElement.
name char * Attribute name to get. If you pass in NULL, this function returns an error.

Certain attribute names are invalid XML. These include those with white space, non-alphanumeric characters, or numbers.
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, the output value is 0. 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

Example

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