AIXMLNodeListSuite Struct Reference
[API Suite List]

This suite allows you to iterate through and manage lists of XML nodes. More...

Public Attributes
AIAPI AIErr(*	GetLength )(AIXMLNodeListRef nodes, ai::int32 *length)
	Retrieves the number of items in a node list.
AIAPI AIErr(*	GetItem )(AIXMLNodeListRef nodes, ai::int32 index, AIXMLNodeRef *node)
	Retrieves an XML node from a node list by position index.
AIAPI AIErr(*	SwapNodes )(AIXMLNodeListRef list1, AIXMLNodeListRef list2, ai::int32 position1, ai::int32 position2)
	Swaps XML nodes between two node lists.

Detailed Description

This suite allows you to iterate through and manage lists of XML nodes.

This suite provides an approximate implementation of the XML Level 1 DOM interface for node lists. See http://www.w3.org/TR/1998/REC-DOM-Level-1-19981001/level-one-core.html#ID-536297177

Retrieves an XML node from a node list by position index.

Use with GetLength() to iterate through a list.

Parameters:

	nodes	The XML node list.
	index	The 0-based position index.
	node	[out] A buffer in which to return the node.

Retrieves the number of items in a node list.

Use with GetItem() to iterate through a list.

Parameters:

	nodes	The XML node list.
	length	[out] A buffer in which to return the number of items.

AIAPI AIErr(* AIXMLNodeListSuite::SwapNodes)(AIXMLNodeListRef list1, AIXMLNodeListRef list2, ai::int32 position1, ai::int32 position2)

Swaps XML nodes between two node lists.

Parameters:

	list1	The first XML node list.
	list2	The second XML node list.
	position1	The 0-based position index of the node in the first list to move to `position2` in the second list.
	position2	The 0-based position index of the node in the second list to move to `position1` in the first list.

The documentation for this struct was generated from the following file: