LabWindows/CVI

CVIXMLLoadDocument

CVIXMLStatus CVIXMLLoadDocument (char *path, CVIXMLDocument *document);

Purpose

Loads an existing XML document.

Parameters

Input
Name Type Description
path char * The pathname of the XML document to load.
Output
Name Type Description
document CVIXMLDocument On output, contains the handle to the document object created in this function. This handle must be discarded using the CVIXMLDiscardDocument 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 CVIXMLLoadDocument function:

  • apps\xmlTree\xmlTree.cws

    Open example
  • toolbox\XMLSample.cws

    Open example