SOAP::VALUES Class Reference

A class to hold the actual parameters and return values of a SOAP message. More...

#include <mi32/soap.h>

List of all members.

Public Types
enum	TYPE {   TYPE_String, TYPE_Double, TYPE_Integer, TYPE_Bool,   TYPE_XML }
Public Member Functions
	VALUES (const HTTPMESSAGE &message)
	VALUES ()
	~VALUES ()
void	Clear ()
XMLNODE *	GetValue (const char *name) const
bool	GetValue (const char *name, bool &value) const
bool	GetValue (const char *name, UINT32 &value) const
bool	GetValue (const char *name, INT32 &value) const
bool	GetValue (const char *name, double &value) const
bool	GetValue (const char *name, STRUTF8 &value) const
bool	GetValue (const char *name, MISTRING &value) const
XMLNODE *	GetXMLNode () const
bool	HasValue (const char *name) const
void	SetValue (const char *name, XMLNODE *node)
void	SetValue (const char *name, bool value)
void	SetValue (const char *name, UINT32 value)
void	SetValue (const char *name, INT32 value)
void	SetValue (const char *name, double value)
void	SetValue (const char *name, const STRUTF8 &value)
void	SetValue (const char *name, const MISTRING &value)
void	SetXMLNode (XMLNODE *node)
Private Member Functions
	VALUES (XMLNODE *node)
Private Attributes
XMLDOC *	m_doc
XMLNODE *	m_node

---

Detailed Description

A class to hold the actual parameters and return values of a SOAP message.

This class is used on by both the caller and the callee.

---

Member Enumeration Documentation

enum SOAP::VALUES::TYPE

Enumerator:

TYPE_String
TYPE_Double
TYPE_Integer
TYPE_Bool
TYPE_XML

---

Constructor & Destructor Documentation

SOAP::VALUES::VALUES

(

)

SOAP::VALUES::VALUES

(

const HTTPMESSAGE &

message

)

SOAP::VALUES::~VALUES

(

)

SOAP::VALUES::VALUES

(

XMLNODE *

node

)

[private]

---

Member Function Documentation

void SOAP::VALUES::Clear

(

)

XMLNODE* SOAP::VALUES::GetValue

(

const char *

name

)

const

Get a parameter or return value's XMLNODE This is useful mainly for items which are complex structures not directly supported by this class.

Returns:

An XMLNODE* or NULL if not found.

bool SOAP::VALUES::GetValue	(	const char *	name,
		bool &	value
	)			const

Get a parameter or return value (bool).

Returns:

true if the parameter was passed, false if not

bool SOAP::VALUES::GetValue	(	const char *	name,
		UINT32 &	value
	)			const

Get a parameter or return value (UINT32).

Returns:

true if the parameter was passed, false if not

bool SOAP::VALUES::GetValue	(	const char *	name,
		INT32 &	value
	)			const

Get a parameter or return value (INT32).

Returns:

true if the parameter was passed, false if not

bool SOAP::VALUES::GetValue	(	const char *	name,
		double &	value
	)			const

Get a parameter or return value (double).

Returns:

true if the parameter was passed, false if not

bool SOAP::VALUES::GetValue	(	const char *	name,
		STRUTF8 &	value
	)			const

Get a parameter or return value (STRUTF8).

Returns:

true if the parameter was passed, false if not

bool SOAP::VALUES::GetValue	(	const char *	name,
		MISTRING &	value
	)			const

Get a parameter or return value (MISTRING).

Returns:

true if the parameter was passed, false if not

XMLNODE* SOAP::VALUES::GetXMLNode

(

)

const

Return the XMLNODE containing all the values.

bool SOAP::VALUES::HasValue

(

const char *

name

)

const

Determine if a value exists.

void SOAP::VALUES::SetValue	(	const char *	name,
		XMLNODE *	node
	)

Set a parameter or return value (XMLNODE) This is mainly for cases where a parameter or value is a complicated structure not directly supported by this class.

Parameters:

	name	The name of the value to set
	node	The XML node to set it from

void SOAP::VALUES::SetValue	(	const char *	name,
		bool	value
	)

Set a parameter or return value (bool).

void SOAP::VALUES::SetValue	(	const char *	name,
		UINT32	value
	)

Set a parameter or return value (UINT32).

void SOAP::VALUES::SetValue	(	const char *	name,
		INT32	value
	)

Set a parameter or return value (INT32).

void SOAP::VALUES::SetValue	(	const char *	name,
		double	value
	)

Set a parameter or return value (double).

void SOAP::VALUES::SetValue	(	const char *	name,
		const STRUTF8 &	value
	)

Set a parameter or return value (STRUTF8).

void SOAP::VALUES::SetValue	(	const char *	name,
		const MISTRING &	value
	)

Set a parameter or return value (MISTRING).

void SOAP::VALUES::SetXMLNode

(

XMLNODE *

node

)

Sets the root node. Makes a copy of the node pased in.

---

Member Data Documentation

XMLDOC* SOAP::VALUES::m_doc [private]

XMLNODE* SOAP::VALUES::m_node [private]

---

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

• mi32/soap.h