ucommon::keydata Class Reference

Data keys parsed from a keyfile. More...

#include <keydata.h>

Inheritance diagram for ucommon::keydata:

[legend]Collaboration diagram for ucommon::keydata:

[legend]

Public Types
typedef linked_pointer< keyvalue >	iterator
	Convenience typedef for iterative pointer.
Public Member Functions
keyvalue *	begin (void)
	Get first value object, for iterative examinations.
void	clear (char *id)
	Remove a keyword id from the keydata structure.
keyvalue *	end (void)
	Get last value object, for iterative examinations.
char *	get (void)
	Get the name of this section.
char *	get (char *id)
	Lookup a key value by it's id.
char *	operator() (char *id)
	Lookup a key value by it's id.
void	set (char *id, char *value)
	Set a keyword and value in the keydata structure.
Friends
class	keyfile
class	keyvalue
Data Structures
class	keyvalue
	A key value set is used for iterative access. More...

---

Detailed Description

Data keys parsed from a keyfile.

This is a specific [] section from a fully loaded keyfile, and offers common means to access data members. This is related to the original GNU Common C++ keydata object, although it is formed in a keyfile class which is loaded from a config file all at once.

Author:

David Sugar <dyfet@gnutelephony.org>

Definition at line 57 of file keydata.h.

---

Member Function Documentation

keyvalue* ucommon::keydata::begin

(

void

)

[inline]

Get first value object, for iterative examinations.

Returns:

first key value in chain.

Definition at line 128 of file keydata.h.

void ucommon::keydata::clear

(

char *

id

)

Remove a keyword id from the keydata structure.

Removed items still use pager allocated memory.

Parameters:

id

to remove.

keyvalue* ucommon::keydata::end

(

void

)

[inline]

Get last value object, for iterative examinations.

Returns:

first key value in chain.

Definition at line 135 of file keydata.h.

char* ucommon::keydata::get

(

void

)

[inline]

Get the name of this section.

Useful in iterative examinations.

Returns:

name of keydata section.

Definition at line 121 of file keydata.h.

char* ucommon::keydata::get

(

char *

id

)

Lookup a key value by it's id.

Parameters:

id

to look for.

Returns:

value string or NULL if not found.

char* ucommon::keydata::operator()

(

char *

id

)

[inline]

Lookup a key value by it's id.

Parameters:

id

to look for.

Returns:

value string or NULL if not found.

Definition at line 98 of file keydata.h.

void ucommon::keydata::set	(	char *	id,
		char *	value
	)

Set a keyword and value in the keydata structure.

If the keyword already exists, it is replaced. Removed items still use pager allocated memory.

Parameters:

	id	to set.
	value	for the id.

---

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

• ucommon/keydata.h

---