SR_Nametags Struct Reference
[SR_Nametags API functions]


Detailed Description

Represents a Nametag collection.

Data Fields

ESR_ReturnCode(* load )(struct SR_Nametags_t *self, const LCHAR *filename)
ESR_ReturnCode(* save )(struct SR_Nametags_t *self, const LCHAR *filename)
ESR_ReturnCode(* add )(struct SR_Nametags_t *self, SR_Nametag *nametag)
ESR_ReturnCode(* remove )(struct SR_Nametags_t *self, const LCHAR *id)
ESR_ReturnCode(* getSize )(struct SR_Nametags_t *self, size_t *result)
ESR_ReturnCode(* get )(struct SR_Nametags_t *self, const LCHAR *id, SR_Nametag **nametag)
ESR_ReturnCode(* getAtIndex )(struct SR_Nametags_t *self, size_t index, SR_Nametag **nametag)
ESR_ReturnCode(* contains )(struct SR_Nametags_t *self, const LCHAR *id, ESR_BOOL *result)
ESR_ReturnCode(* destroy )(struct SR_Nametags_t *self)

Field Documentation

ESR_ReturnCode(* SR_Nametags::load)(struct SR_Nametags_t *self, const LCHAR *filename)

Loads a nametag collection.

Parameters:
self Nametags handle
filename File to read from

ESR_ReturnCode(* SR_Nametags::save)(struct SR_Nametags_t *self, const LCHAR *filename)

Saves a nametag collection.

Parameters:
self Nametags handle
filename File to write to

ESR_ReturnCode(* SR_Nametags::add)(struct SR_Nametags_t *self, SR_Nametag *nametag)

Adds nametag to collection.

Parameters:
self Nametags handle
nametag Nametag to be added

ESR_ReturnCode(* SR_Nametags::remove)(struct SR_Nametags_t *self, const LCHAR *id)

Removes nametag from collection.

Parameters:
self Nametags handle
id ID of nametag to be removed

ESR_ReturnCode(* SR_Nametags::getSize)(struct SR_Nametags_t *self, size_t *result)

Returns the number of nametags within the collection.

Parameters:
self Nametags handle
result Resulting value

ESR_ReturnCode(* SR_Nametags::get)(struct SR_Nametags_t *self, const LCHAR *id, SR_Nametag **nametag)

Returns Nametag with the specified ID. It is illegal to destroy the returned Nametag until it is removed from the Nametags collection.

Parameters:
self Nametags handle
ud Nametag id
nametag Nametag at index

ESR_ReturnCode(* SR_Nametags::getAtIndex)(struct SR_Nametags_t *self, size_t index, SR_Nametag **nametag)

Returns Nametag at the specified index. It is illegal to destroy the returned Nametag until it is removed from the Nametags collection.

Parameters:
self Nametags handle
index Nametag index
nametag Nametag at index

ESR_ReturnCode(* SR_Nametags::contains)(struct SR_Nametags_t *self, const LCHAR *id, ESR_BOOL *result)

Indicates if collection contains specified nametag.

Parameters:
self Nametags handle
id Nametag ID to search for
result True if nametag was found

ESR_ReturnCode(* SR_Nametags::destroy)(struct SR_Nametags_t *self)

Destroys a nametag collection.

Parameters:
self Nametags handle


Generated on Thu May 1 15:37:28 2008 for SREC by  doxygen 1.5.3