AIXMLNamedNodeMapSuite Struct Reference
[API Suite List]

This suite allows you to access XML named node maps. More...

#include <AIXMLElement.h>

List of all members.

Public Attributes
AIAPI AIErr(*	GetLength )(AIXMLNamedNodeMapRef map, ai::int32 *length)
	Retrieves the size of a named node map.
AIAPI AIErr(*	GetItem )(AIXMLNamedNodeMapRef map, ai::int32 index, AIXMLNodeRef *node)
	Retrieves an XML node from a node map by position index.
AIAPI AIErr(*	GetNamedItem )(AIXMLNamedNodeMapRef map, AIXMLName name, AIXMLNodeRef *node)
	Retrieves a node by name from a node map.
AIAPI AIErr(*	SetNamedItem )(AIXMLNamedNodeMapRef map, AIXMLNodeRef node)
	Adds a named node to a node map, replacing it if it is already included.
AIAPI AIErr(*	RemoveNamedItem )(AIXMLNamedNodeMapRef map, AIXMLNodeRef node)
	Removes a named node from a node map.

---

Detailed Description

This suite allows you to access XML named node maps.

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

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIXMLNamedNodeMapSuite and kAIXMLNamedNodeMapSuiteVersion.

---

Member Data Documentation

AIAPI AIErr(* AIXMLNamedNodeMapSuite::GetItem)(AIXMLNamedNodeMapRef map, ai::int32 index, AIXMLNodeRef *node)

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

Use with GetLength() to iterate through a map.

Parameters:

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

AIAPI AIErr(* AIXMLNamedNodeMapSuite::GetLength)(AIXMLNamedNodeMapRef map, ai::int32 *length)

Retrieves the size of a named node map.

Use with GetItem() to iterate through items in the map.

Parameters:

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

AIAPI AIErr(* AIXMLNamedNodeMapSuite::GetNamedItem)(AIXMLNamedNodeMapRef map, AIXMLName name, AIXMLNodeRef *node)

Retrieves a node by name from a node map.

Parameters:

	map	The node map.
	name	The node name.
	node	[out] A buffer in which to return the node.

AIAPI AIErr(* AIXMLNamedNodeMapSuite::RemoveNamedItem)(AIXMLNamedNodeMapRef map, AIXMLNodeRef node)

Removes a named node from a node map.

There is no error if the node was not in the map.

Parameters:

	map	The node map.
	name	The node name.

AIAPI AIErr(* AIXMLNamedNodeMapSuite::SetNamedItem)(AIXMLNamedNodeMapRef map, AIXMLNodeRef node)

Adds a named node to a node map, replacing it if it is already included.

Parameters:

	map	The node map.
	name	The node name.

---

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

• AIXMLElement.h