SR_Nametags API functions


Detailed Description

Represents a Nametag collection.


Data Structures

struct  SR_Nametags

Nametags operations

SREC_NAMETAG_API
ESR_ReturnCode 
SR_NametagsCreate (SR_Nametags **self)
SREC_NAMETAG_API
ESR_ReturnCode 
SR_NametagsLoad (SR_Nametags *self, const LCHAR *filename)
SREC_NAMETAG_API
ESR_ReturnCode 
SR_NametagsSave (SR_Nametags *self, const LCHAR *filename)
SREC_NAMETAG_API
ESR_ReturnCode 
SR_NametagsAdd (SR_Nametags *self, SR_Nametag *nametag)
SREC_NAMETAG_API
ESR_ReturnCode 
SR_NametagsRemove (SR_Nametags *self, const LCHAR *id)
SREC_NAMETAG_API
ESR_ReturnCode 
SR_NametagsGetSize (SR_Nametags *self, size_t *result)
SREC_NAMETAG_API
ESR_ReturnCode 
SR_NametagsGet (SR_Nametags *self, const LCHAR *id, SR_Nametag **nametag)
SREC_NAMETAG_API
ESR_ReturnCode 
SR_NametagsGetAtIndex (SR_Nametags *self, size_t index, SR_Nametag **nametag)
SREC_NAMETAG_API
ESR_ReturnCode 
SR_NametagsContains (SR_Nametags *self, const LCHAR *id, ESR_BOOL *result)
SREC_NAMETAG_API
ESR_ReturnCode 
SR_NametagsDestroy (SR_Nametags *self)


Function Documentation

SREC_NAMETAG_API ESR_ReturnCode SR_NametagsAdd ( SR_Nametags self,
SR_Nametag nametag 
)

Adds nametag to collection.

Parameters:
self Nametags handle
nametag Nametag to be added

SREC_NAMETAG_API ESR_ReturnCode SR_NametagsContains ( SR_Nametags 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

SREC_NAMETAG_API ESR_ReturnCode SR_NametagsCreate ( SR_Nametags **  self  ) 

Create a new Nametag collection.

Parameters:
self Nametags handle

SREC_NAMETAG_API ESR_ReturnCode SR_NametagsDestroy ( SR_Nametags self  ) 

Destroys a Nametag collection.

Parameters:
self Nametag handle

SREC_NAMETAG_API ESR_ReturnCode SR_NametagsGet ( SR_Nametags 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
id Nametag ID
nametag Nametag at index

SREC_NAMETAG_API ESR_ReturnCode SR_NametagsGetAtIndex ( SR_Nametags 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

SREC_NAMETAG_API ESR_ReturnCode SR_NametagsGetSize ( SR_Nametags self,
size_t *  result 
)

Returns the number of nametags within the collection.

Parameters:
self Nametags handle
result Resulting value

SREC_NAMETAG_API ESR_ReturnCode SR_NametagsLoad ( SR_Nametags self,
const LCHAR filename 
)

Loads a nametag collection.

Parameters:
self Nametags handle
filename File to read from

SREC_NAMETAG_API ESR_ReturnCode SR_NametagsRemove ( SR_Nametags self,
const LCHAR id 
)

Removes nametag from collection.

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

SREC_NAMETAG_API ESR_ReturnCode SR_NametagsSave ( SR_Nametags self,
const LCHAR filename 
)

Saves a nametag collection.

Parameters:
self Nametags handle
filename File to write to


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