PARARRAY: Creation and destruction

Namespaces
namespace	RVL
Modules
	Output to stream
	Parameter access - first occurence
	Gets value defined in the first occurence of the key.
	Parameter access - last occurence
	Get value defined in the last occurence of the key.
	Parameter assignment - first occurence
	Set value defined in the first occurence of the key, or add key=value pair to list if key not already present.
	parse functions
Functions
PARARRAY *	ps_new ()
	Default - no keyval pairs, only one link.
void	ps_delete (PARARRAY **p)
	Destroys all links, frees all memory associated with object, returns *p = NULL.
int	ps_setnull (PARARRAY *parr)
	Deletes, reinitializes list - provided for backward compatibility.
bool	RVL::parse (PARARRAY const &par, std::string name, char &val)
bool	RVL::parse (PARARRAY const &par, std::string name, short &val)
bool	RVL::parse (PARARRAY const &par, std::string name, int &val)
bool	RVL::parse (PARARRAY const &par, std::string name, long &val)
bool	RVL::parse (PARARRAY const &par, std::string name, unsigned short &val)
bool	RVL::parse (PARARRAY const &par, std::string name, unsigned int &val)
bool	RVL::parse (PARARRAY const &par, std::string name, unsigned long &val)
bool	RVL::parse (PARARRAY const &par, std::string name, float &val)
bool	RVL::parse (PARARRAY const &par, std::string name, double &val)
bool	RVL::parse (PARARRAY const &par, std::string name, bool &val)
template<typename T>
T	RVL::valparse (PARARRAY const &par, std::string name, T def)
	assigns default if returns false
template<typename T>
T	RVL::valparse (PARARRAY const &par, std::string name)
	throws exception if returns false
Variables
WORD *	s_KEYVAL::val
s_PSLINK *	s_PSLINK::prev
s_PSLINK *	s_PSLINK::next

---

Function Documentation

PARARRAY* ps_new

(

)

Default - no keyval pairs, only one link.

Returns:

"bare" PARARRAY

void ps_delete

(

PARARRAY **

p

)

Destroys all links, frees all memory associated with object, returns *p = NULL.

Parameters:

[out]

pointer

to object address

int ps_setnull

(

PARARRAY *

parr

)

Deletes, reinitializes list - provided for backward compatibility.

Parameters:

[out]

parr

(PARARRAY *) - parameter array to initialize

Returns:

(int) 0 if successful, else nonzero error code.

bool RVL::parse	(	PARARRAY const &	par,
		std::string	name,
		char &	val
	)

bool RVL::parse	(	PARARRAY const &	par,
		std::string	name,
		short &	val
	)

bool RVL::parse	(	PARARRAY const &	par,
		std::string	name,
		int &	val
	)

bool RVL::parse	(	PARARRAY const &	par,
		std::string	name,
		long &	val
	)

bool RVL::parse	(	PARARRAY const &	par,
		std::string	name,
		unsigned short &	val
	)

bool RVL::parse	(	PARARRAY const &	par,
		std::string	name,
		unsigned int &	val
	)

bool RVL::parse	(	PARARRAY const &	par,
		std::string	name,
		unsigned long &	val
	)

bool RVL::parse	(	PARARRAY const &	par,
		std::string	name,
		float &	val
	)

bool RVL::parse	(	PARARRAY const &	par,
		std::string	name,
		double &	val
	)

bool RVL::parse	(	PARARRAY const &	par,
		std::string	name,
		bool &	val
	)

template<typename T>

T RVL::valparse	(	PARARRAY const &	par,
		std::string	name,
		T	def
	)

assigns default if returns false

Definition at line 273 of file parser.h.

References RVL::parse().

template<typename T>

T RVL::valparse	(	PARARRAY const &	par,
		std::string	name
	)

throws exception if returns false

Definition at line 279 of file parser.h.

References RVL::parse().

---

Variable Documentation

WORD* s_KEYVAL::val [inherited]

Definition at line 15 of file parser.h.

struct s_PSLINK* s_PSLINK::prev [inherited]

Definition at line 20 of file parser.h.

struct s_PSLINK* s_PSLINK::next [inherited]

Definition at line 21 of file parser.h.

---