dictionary.h File Reference

#include <mupnp/typedef.h>
#include <mupnp/util/list.h>
#include <mupnp/util/string.h>

Data Structures
struct	_mUpnpDictionary
	The generic wrapper struct for mUPnP's dictionarys. More...

Macros
#define	mupnp_dictionary_element_setkey(dirElem, name)
#define	mupnp_dictionary_element_getkey(dirElem)
#define	mupnp_dictionary_element_setvalue(dirElem, val)
#define	mupnp_dictionary_element_getvalue(dirElem)
#define	mupnp_dictionary_element_next(dirElem)
#define	mupnp_dictionary_element_remove(dirElem)
#define	mupnp_dictionary_clear(dir)
#define	mupnp_dictionary_size(dir)
#define	mupnp_dictionary_gets(dir)
#define	mupnp_dictionary_add(dir, dirElem)
#define	mupnp_dictionary_remove(dirElem)

Typedefs
typedef struct _mUpnpDictionary	mUpnpDictionaryElement
	The generic wrapper struct for mUPnP's dictionarys.
typedef struct _mUpnpDictionary	mUpnpDictionary

Functions
mUpnpDictionaryElement *	mupnp_dictionary_element_new (void)
bool	mupnp_dictionary_element_delete (mUpnpDictionaryElement *dirElem)
mUpnpDictionary *	mupnp_dictionary_new (void)
void	mupnp_dictionary_delete (mUpnpDictionary *dir)
mUpnpDictionaryElement *	mupnp_dictionary_get (mUpnpDictionary *dir, const char *key)
void	mupnp_dictionary_setvalue (mUpnpDictionary *dir, const char *key, const char *value)
const char *	mupnp_dictionary_getvalue (mUpnpDictionary *dir, const char *key)

Macro Definition Documentation

mupnp_dictionary_add

#define mupnp_dictionary_add	(		dir,
			dirElem )

Value:

mupnp_list_add((mUpnpList*)dir, (mUpnpList*)dirElem)

Add a dictionary into a dictionary list

Parameters

dir	The dictionary list in question
dirElem	The dictionary to add to the list

mupnp_dictionary_clear

#define mupnp_dictionary_clear

(

dir

)

Value:

mupnp_list_clear((mUpnpList*)dir, (MUPNP_LIST_DESTRUCTORFUNC)mupnp_dictionary_element_delete)

Clear the contents of a dictionary list

Parameters

dir	Dictionary list in question

mupnp_dictionary_element_getkey

#define mupnp_dictionary_element_getkey

(

dirElem

)

Value:

mupnp_string_getvalue(dirElem->key)

Get a key

Parameters

dirElem

Dictionary struct

mupnp_dictionary_element_getvalue

#define mupnp_dictionary_element_getvalue

(

dirElem

)

Value:

mupnp_string_getvalue(dirElem->value)

Get a value

Parameters

dirElem

Dictionary struct

mupnp_dictionary_element_next

#define mupnp_dictionary_element_next

(

dirElem

)

Value:

(mUpnpDictionaryElement*)mupnp_list_next((mUpnpList*)dirElem)

mupnp_dictionary_element_remove

#define mupnp_dictionary_element_remove

(

dirElem

)

Value:

mupnp_list_remove((mUpnpList*)dirElem)

mupnp_dictionary_element_setkey

#define mupnp_dictionary_element_setkey	(		dirElem,
			name )

Value:

mupnp_string_setvalue(dirElem->key, name)

Set a key

Parameters

dirElem	Dictionary struct
name	String to set

mupnp_dictionary_element_setvalue

#define mupnp_dictionary_element_setvalue	(		dirElem,
			val )

Value:

mupnp_string_setvalue(dirElem->value, val)

Set a value

Parameters

dirElem	Dictionary struct
value	String to set

mupnp_dictionary_gets

#define mupnp_dictionary_gets

(

dir

)

Value:

(mUpnpDictionaryElement*)mupnp_list_next((mUpnpList*)dir)

Get the first actual item from a dictionary list to use as an iterator

Parameters

dir	The dictionary list in question

mupnp_dictionary_remove

#define mupnp_dictionary_remove

(

dirElem

)

Value:

mupnp_list_remove((mUpnpList*)dirElem)

Remove a dictionary from dictionary list

Parameters

dirElem

The dictionary to be removed

mupnp_dictionary_size

#define mupnp_dictionary_size

(

dir

)

Value:

mupnp_list_size((mUpnpList*)dir)

Get the size of a dictionary list

Parameters

dir	The dictionary list in question

Typedef Documentation

mUpnpDictionary

typedef struct _mUpnpDictionary mUpnpDictionary

mUpnpDictionaryElement

typedef struct _mUpnpDictionary mUpnpDictionaryElement

The generic wrapper struct for mUPnP's dictionarys.

This wrapper has been created to enable 100% code compatibility between different platforms (Linux, Win32 etc..)

Function Documentation

mupnp_dictionary_delete()

void mupnp_dictionary_delete

(

mUpnpDictionary *

dir

)

Destroy a dictionary list

Parameters

dir	The dictionary list in question

mupnp_dictionary_element_delete()

bool mupnp_dictionary_element_delete

(

mUpnpDictionaryElement *

dirElem

)

Destroy a dictionary.

Parameters

dirElem

Dictionary to destroy

mupnp_dictionary_element_new()

mUpnpDictionaryElement * mupnp_dictionary_element_new

(

void

)

Create a new dictionary

mupnp_dictionary_get()

mUpnpDictionaryElement * mupnp_dictionary_get	(	mUpnpDictionary *	dir,
		const char *	key )

Get a element of the specified key

Parameters

dir	The dictionary list in question
key	Name to search.

Returns

Element of the specified key.

mupnp_dictionary_getvalue()

const char * mupnp_dictionary_getvalue	(	mUpnpDictionary *	dir,
		const char *	key )

Get a value of the specified key

Parameters

dir	The dictionary list in question
key	Name to search.

Returns

Value of the specified key.

mupnp_dictionary_new()

mUpnpDictionary * mupnp_dictionary_new

(

void

)

Create a new dictionary list

Returns

Dictionary list

mupnp_dictionary_setvalue()

void mupnp_dictionary_setvalue	(	mUpnpDictionary *	dir,
		const char *	key,
		const char *	value )

Set a new element into a dictionary

Parameters

dir	The dictionary list in question
key	Name to set.
value	Value to set.