Interface for XML nodes. More...

#include <sxml-i.h>

Inheritance diagram for IXmlNode:

Public Member Functions
void	ToString (IStringW *out) SCONST PURE
	Converts the node to a string representation.

LPVOID	GetPrivPtr () SCONST PURE
	Gets the private pointer associated with the node.

BOOL	Empty () SCONST PURE
	Checks if the node is empty.

const wchar_t *	Name () SCONST PURE
	Gets the name of the node.

const wchar_t *	Value () SCONST PURE
	Gets the value of the node.

const wchar_t *	Text () SCONST PURE
	Gets the text content of the node.

BOOL	set_userdata (int data) PURE
	Sets user-defined data associated with the node.

int	get_userdata () SCONST PURE
	Gets user-defined data associated with the node.

IXmlAttr *	Attribute (const wchar_t *name, BOOL bCaseSensitive) SCONST PURE
	Gets an attribute by name.

IXmlAttr *	FirstAttribute () SCONST PURE
	Gets the first attribute in the attribute list.

IXmlAttr *	LastAttribute () SCONST PURE
	Gets the last attribute in the attribute list.

IXmlNode *	Child (const wchar_t *name, BOOL bCaseSensitive) SCONST PURE
	Gets a child node by name.

IXmlNode *	FirstChild () SCONST PURE
	Gets the first child node.

IXmlNode *	LastChild () SCONST PURE
	Gets the last child node.

IXmlNode *	NextSibling () SCONST PURE
	Gets the next sibling node in the children list of the parent node.

IXmlNode *	PrevSibling () SCONST PURE
	Gets the previous sibling node in the children list of the parent node.

IXmlNode *	NextSibling2 (const wchar_t *name, BOOL bCaseSensitive) SCONST PURE
	Gets the next sibling node with the specified name.

IXmlNode *	PrevSibling2 (const wchar_t *name, BOOL bCaseSensitive) SCONST PURE
	Gets the previous sibling node with the specified name.

IXmlNode *	AppendChild (const wchar_t *name) PURE
	Appends a child node with the specified name.

IXmlNode *	PrependChild (const wchar_t *name) PURE
	Prepends a child node with the specified name.

IXmlNode *	AppendCopyNode (const IXmlNode *proto) PURE
	Appends a copy of the specified node as a child.

IXmlNode *	PrependCopyNode (const IXmlNode *proto) PURE
	Prepends a copy of the specified node as a child.

IXmlAttr *	AppendAttribute (const wchar_t *name) PURE
	Appends an attribute with the specified name.

IXmlAttr *	PrependAttribute (const wchar_t *name) PURE
	Prepends an attribute with the specified name.

IXmlAttr *	AppendCopyAttribute (const IXmlAttr *proto) PURE
	Appends a copy of the specified attribute.

IXmlAttr *	PrependCopyAttribute (const IXmlAttr *proto) PURE
	Prepends a copy of the specified attribute.

BOOL	RemoveAttribute (const wchar_t *name) PURE
	Removes an attribute by name.

BOOL	RemoveChild (const wchar_t *name) PURE
	Removes a child node by name.

BOOL	RemoveAllChilden () PURE
	Removes all child nodes.

Detailed Description

Interface for XML nodes.

Definition at line 127 of file sxml-i.h.

Member Function Documentation

◆ AppendAttribute()

IXmlAttr * IXmlNode::AppendAttribute ( const wchar_t * name )

Appends an attribute with the specified name.

Parameters

name	Name of the attribute.

Returns: Pointer to the newly appended attribute.

Implemented in SXmlNode.

◆ AppendChild()

IXmlNode * IXmlNode::AppendChild ( const wchar_t * name )

Appends a child node with the specified name.

Parameters

name	Name of the child node.

Returns: Pointer to the newly appended child node.

Implemented in SXmlNode.

◆ AppendCopyAttribute()

IXmlAttr * IXmlNode::AppendCopyAttribute ( const IXmlAttr * proto )

Appends a copy of the specified attribute.

Parameters

proto Pointer to the attribute to copy.

Returns: Pointer to the newly appended attribute.

Implemented in SXmlNode.

◆ AppendCopyNode()

IXmlNode * IXmlNode::AppendCopyNode ( const IXmlNode * proto )

Appends a copy of the specified node as a child.

Parameters

proto Pointer to the node to copy.

Returns: Pointer to the newly appended child node.

Implemented in SXmlNode.

◆ Attribute()

IXmlAttr * IXmlNode::Attribute	(	const wchar_t *	name,
		BOOL	bCaseSensitive )

Gets an attribute by name.

Parameters

name	Name of the attribute.
bCaseSensitive	TRUE if the search is case-sensitive, FALSE otherwise.

Returns: Pointer to the attribute, or NULL if not found.

Implemented in SXmlNode.

◆ Child()

IXmlNode * IXmlNode::Child	(	const wchar_t *	name,
		BOOL	bCaseSensitive )

Gets a child node by name.

Parameters

name	Name of the child node.
bCaseSensitive	TRUE if the search is case-sensitive, FALSE otherwise.

Returns: Pointer to the child node, or NULL if not found.

Implemented in SXmlNode.

◆ Empty()

BOOL IXmlNode::Empty ( )

Checks if the node is empty.

Returns: TRUE if the node is empty, FALSE otherwise.

Implemented in SXmlNode.

◆ FirstAttribute()

IXmlAttr * IXmlNode::FirstAttribute ( )

Gets the first attribute in the attribute list.

Returns: Pointer to the first attribute, or NULL if there are no attributes.

Implemented in SXmlNode.

◆ FirstChild()

IXmlNode * IXmlNode::FirstChild ( )

Gets the first child node.

Returns: Pointer to the first child node, or NULL if there are no child nodes.

Implemented in SXmlNode.

◆ get_userdata()

int IXmlNode::get_userdata ( )

Gets user-defined data associated with the node.

Returns: User-defined data.

Implemented in SXmlNode.

◆ GetPrivPtr()

LPVOID IXmlNode::GetPrivPtr ( )

Gets the private pointer associated with the node.

Returns: Pointer to private data.

Implemented in SXmlNode.

◆ LastAttribute()

IXmlAttr * IXmlNode::LastAttribute ( )

Gets the last attribute in the attribute list.

Returns: Pointer to the last attribute, or NULL if there are no attributes.

Implemented in SXmlNode.

◆ LastChild()

IXmlNode * IXmlNode::LastChild ( )

Gets the last child node.

Returns: Pointer to the last child node, or NULL if there are no child nodes.

Implemented in SXmlNode.

◆ Name()

const wchar_t * IXmlNode::Name ( )

Gets the name of the node.

Returns: The name of the node.

Implemented in SXmlNode.

◆ NextSibling()

IXmlNode * IXmlNode::NextSibling ( )

Gets the next sibling node in the children list of the parent node.

Returns: Pointer to the next sibling node, or NULL if there is no next sibling.

Implemented in SXmlNode.

◆ NextSibling2()

IXmlNode * IXmlNode::NextSibling2	(	const wchar_t *	name,
		BOOL	bCaseSensitive )

Gets the next sibling node with the specified name.

Parameters

name	Name of the sibling node.
bCaseSensitive	TRUE if the search is case-sensitive, FALSE otherwise.

Returns: Pointer to the next sibling node with the specified name, or NULL if not found.

Implemented in SXmlNode.

◆ PrependAttribute()

IXmlAttr * IXmlNode::PrependAttribute ( const wchar_t * name )

Prepends an attribute with the specified name.

Parameters

name	Name of the attribute.

Returns: Pointer to the newly prepended attribute.

Implemented in SXmlNode.

◆ PrependChild()

IXmlNode * IXmlNode::PrependChild ( const wchar_t * name )

Prepends a child node with the specified name.

Parameters

name	Name of the child node.

Returns: Pointer to the newly prepended child node.

Implemented in SXmlNode.

◆ PrependCopyAttribute()

IXmlAttr * IXmlNode::PrependCopyAttribute ( const IXmlAttr * proto )

Prepends a copy of the specified attribute.

Parameters

proto Pointer to the attribute to copy.

Returns: Pointer to the newly prepended attribute.

Implemented in SXmlNode.

◆ PrependCopyNode()

IXmlNode * IXmlNode::PrependCopyNode ( const IXmlNode * proto )

Prepends a copy of the specified node as a child.

Parameters

proto Pointer to the node to copy.

Returns: Pointer to the newly prepended child node.

Implemented in SXmlNode.

◆ PrevSibling()

IXmlNode * IXmlNode::PrevSibling ( )

Gets the previous sibling node in the children list of the parent node.

Returns: Pointer to the previous sibling node, or NULL if there is no previous sibling.

Implemented in SXmlNode.

◆ PrevSibling2()

IXmlNode * IXmlNode::PrevSibling2	(	const wchar_t *	name,
		BOOL	bCaseSensitive )

Gets the previous sibling node with the specified name.

Parameters

name	Name of the sibling node.
bCaseSensitive	TRUE if the search is case-sensitive, FALSE otherwise.

Returns: Pointer to the previous sibling node with the specified name, or NULL if not found.

Implemented in SXmlNode.

◆ RemoveAllChilden()

BOOL IXmlNode::RemoveAllChilden ( )

Removes all child nodes.

Returns: TRUE if all child nodes were removed, FALSE otherwise.

Implemented in SXmlNode.

◆ RemoveAttribute()

BOOL IXmlNode::RemoveAttribute ( const wchar_t * name )

Removes an attribute by name.

Parameters

name	Name of the attribute to remove.

Returns: TRUE if the attribute was removed, FALSE otherwise.

Implemented in SXmlNode.

◆ RemoveChild()

BOOL IXmlNode::RemoveChild ( const wchar_t * name )

Removes a child node by name.

Parameters

name	Name of the child node to remove.

Returns: TRUE if the child node was removed, FALSE otherwise.

Implemented in SXmlNode.

◆ set_userdata()

BOOL IXmlNode::set_userdata ( int data )

Sets user-defined data associated with the node.

Parameters

data	User-defined data.

Returns: TRUE if successful, FALSE otherwise.

Implemented in SXmlNode.

◆ Text()

const wchar_t * IXmlNode::Text ( )

Gets the text content of the node.

Returns: The text content of the node.

Implemented in SXmlNode.

◆ ToString()

void IXmlNode::ToString ( IStringW * out )

Converts the node to a string representation.

Parameters

out	Pointer to the output string.

Implemented in SXmlNode.

◆ Value()

const wchar_t * IXmlNode::Value ( )

Gets the value of the node.

Returns: The value of the node.

Implemented in SXmlNode.

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

utilities/include/interface/sxml-i.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ AppendAttribute()

◆ AppendChild()

◆ AppendCopyAttribute()

◆ AppendCopyNode()

◆ Attribute()

◆ Child()

◆ Empty()

◆ FirstAttribute()

◆ FirstChild()

◆ get_userdata()

◆ GetPrivPtr()

◆ LastAttribute()

◆ LastChild()

◆ Name()

◆ NextSibling()

◆ NextSibling2()

◆ PrependAttribute()

◆ PrependChild()

◆ PrependCopyAttribute()

◆ PrependCopyNode()

◆ PrevSibling()

◆ PrevSibling2()

◆ RemoveAllChilden()

◆ RemoveAttribute()

◆ RemoveChild()

◆ set_userdata()

◆ Text()

◆ ToString()

◆ Value()