TSLOGCAttributes Class Reference

Detailed Description

This class is reserved for future use.

Public Member Functions
	TSLOGCAttributes ()
	~TSLOGCAttributes ()
bool	addAttribute (const char *key, const char *value)
const char *	getAttribute (const char *key) const
const char *	getAttribute (unsigned int index, const char **key=0) const
unsigned int	noOfAttributes () const
bool	removeAttribute (const char *key)

Constructor & Destructor Documentation

TSLOGCAttributes()

TSLOGCAttributes::TSLOGCAttributes

(

)

~TSLOGCAttributes()

TSLOGCAttributes::~TSLOGCAttributes

(

)

Member Function Documentation

addAttribute()

bool TSLOGCAttributes::addAttribute	(	const char *	key,
		const char *	value )

Adds a new attribute or replaces the value of an existing attribute.

Parameters

key	The key of the attribute. This must be unique otherwise it will replace the value of any attribute that already uses this key.
value	The value to set

Returns

true if a new attribute was set, false if either parameter was invalid or an existing attribute's value was replaced.

getAttribute() [1/2]

const char * TSLOGCAttributes::getAttribute

(

const char *

key

)

const

Queries the value of an existing attribute by key.

Parameters

key	The key to query.

Returns

the value of the attribute whose key was passed or null if the key passed was invalid or an attribute with that key does not exist.

getAttribute() [2/2]

const char * TSLOGCAttributes::getAttribute	(	unsigned int	index,
		const char **	key = 0 ) const

Queries the value of an existing attribute by index.

NOTE: The attributes are held internally alphabetically, so adding an attribute may cause a reordering of the indices of the contained attributes.

Parameters

index	The index of the attribute to query.
key	To query the key also, this parameter may be provided and will be pointed to the target key.

Returns

the value of the attribute at the target index or null if the index passed was invalid.

noOfAttributes()

unsigned int TSLOGCAttributes::noOfAttributes

(

)

const

Queries the number of attributes contained.

removeAttribute()

bool TSLOGCAttributes::removeAttribute

(

const char *

key

)

Removes the attribute with the key passed.

Parameters

key	The key of the attribute to remove.

Returns

true if the target attribute was removed and false in all other cases.