IXmlAttr Interface Reference

Interface for XML attributes. More...

#include <sxml-i.h>

Inheritance diagram for IXmlAttr:

Public Member Functions
LPVOID	GetPrivPtr () SCONST PURE
	Gets the private pointer associated with the attribute.
BOOL	Empty () SCONST PURE
	Checks if the attribute is empty.
const wchar_t *	Name () SCONST PURE
	Gets the name of the attribute.
const wchar_t *	Value () SCONST PURE
	Gets the value of the attribute.
BOOL	set_userdata (int data) PURE
	Sets user-defined data associated with the attribute.
int	get_userdata () SCONST PURE
	Gets user-defined data associated with the attribute.
IXmlAttr *	Next () PURE
	Gets the next attribute in the attribute list of the parent node.
IXmlAttr *	Prev () PURE
	Gets the previous attribute in the attribute list of the parent node.
int	AsInt (int def=0) PURE
	Converts the attribute value to an integer.
unsigned int	AsUint (int def=0) PURE
	Converts the attribute value to an unsigned integer.
float	AsFloat (float def=0.0f) PURE
	Converts the attribute value to a float.
double	AsDouble (double def=0.0) PURE
	Converts the attribute value to a double.
BOOL	AsBool (BOOL def=FALSE) PURE
	Converts the attribute value to a boolean.

Detailed Description

Interface for XML attributes.

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

Member Function Documentation

AsBool()

BOOL IXmlAttr::AsBool

(

BOOL

def = FALSE

)

Converts the attribute value to a boolean.

Parameters

def	Default value to return if conversion fails.

Returns

The boolean value of the attribute, or the default value if conversion fails.

Implemented in SXmlAttr.

AsDouble()

double IXmlAttr::AsDouble

(

double

def = 0.0

)

Converts the attribute value to a double.

Parameters

def	Default value to return if conversion fails.

Returns

The double value of the attribute, or the default value if conversion fails.

Implemented in SXmlAttr.

AsFloat()

float IXmlAttr::AsFloat

(

float

def = 0.0f

)

Converts the attribute value to a float.

Parameters

def	Default value to return if conversion fails.

Returns

The float value of the attribute, or the default value if conversion fails.

Implemented in SXmlAttr.

AsInt()

int IXmlAttr::AsInt

(

int

def = 0

)

Converts the attribute value to an integer.

Parameters

def	Default value to return if conversion fails.

Returns

The integer value of the attribute, or the default value if conversion fails.

Implemented in SXmlAttr.

AsUint()

unsigned int IXmlAttr::AsUint

(

int

def = 0

)

Converts the attribute value to an unsigned integer.

Parameters

def	Default value to return if conversion fails.

Returns

The unsigned integer value of the attribute, or the default value if conversion fails.

Implemented in SXmlAttr.

Empty()

BOOL IXmlAttr::Empty

(

)

Checks if the attribute is empty.

Returns

TRUE if the attribute is empty, FALSE otherwise.

Implemented in SXmlAttr.

get_userdata()

int IXmlAttr::get_userdata

(

)

Gets user-defined data associated with the attribute.

Returns

User-defined data.

Implemented in SXmlAttr.

GetPrivPtr()

LPVOID IXmlAttr::GetPrivPtr

(

)

Gets the private pointer associated with the attribute.

Returns

Pointer to private data.

Implemented in SXmlAttr.

Name()

const wchar_t * IXmlAttr::Name

(

)

Gets the name of the attribute.

Returns

The name of the attribute, or an empty string if the attribute is empty.

Implemented in SXmlAttr.

Next()

IXmlAttr * IXmlAttr::Next

(

)

Gets the next attribute in the attribute list of the parent node.

Returns

Pointer to the next attribute, or NULL if there is no next attribute.

Implemented in SXmlAttr.

Prev()

IXmlAttr * IXmlAttr::Prev

(

)

Gets the previous attribute in the attribute list of the parent node.

Returns

Pointer to the previous attribute, or NULL if there is no previous attribute.

Implemented in SXmlAttr.

set_userdata()

BOOL IXmlAttr::set_userdata

(

int

data

)

Sets user-defined data associated with the attribute.

Parameters

data	User-defined data.

Returns

TRUE if successful, FALSE otherwise.

Implemented in SXmlAttr.

Value()

const wchar_t * IXmlAttr::Value

(

)

Gets the value of the attribute.

Returns

The value of the attribute, or an empty string if the attribute is empty.

Implemented in SXmlAttr.

---

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

• utilities/include/interface/sxml-i.h