SR_Nametag Struct Reference
[SR_Nametag API functions]


Detailed Description

Represents a nametag.

Data Fields

ESR_ReturnCode(* getID )(const struct SR_Nametag_t *self, LCHAR **id)
ESR_ReturnCode(* getValue )(const struct SR_Nametag_t *self, const char **pvalue, size_t *plen)
ESR_ReturnCode(* setID )(struct SR_Nametag_t *self, const LCHAR *id)
ESR_ReturnCode(* clone )(const struct SR_Nametag_t *self, struct SR_Nametag_t **result)
ESR_ReturnCode(* destroy )(struct SR_Nametag_t *self)

Field Documentation

ESR_ReturnCode(* SR_Nametag::getID)(const struct SR_Nametag_t *self, LCHAR **id)

Returns the Nametag ID.

Parameters:
self Nametag handle
id Nametag ID
Returns:
ESR_INVALID_ARGUMENT if self is null

ESR_ReturnCode(* SR_Nametag::getValue)(const struct SR_Nametag_t *self, const char **pvalue, size_t *plen)

Returns the Nametag ID.

Parameters:
self Nametag handle
pvalue pointer to the transcription, SR_Nametag retains ownership
plen pointer to the length of the transcription
Returns:
ESR_NO_MATCH_ERROR if self is null or bad voice tag

ESR_ReturnCode(* SR_Nametag::setID)(struct SR_Nametag_t *self, const LCHAR *id)

Sets the Nametag ID.

Parameters:
self Nametag handle
id Nametag ID
Returns:
ESR_INVALID_ARGUMENT if self is null; ESR_OUT_OF_MEMORY if system is out of memory

ESR_ReturnCode(* SR_Nametag::clone)(const struct SR_Nametag_t *self, struct SR_Nametag_t **result)

Clones a nametag.

Parameters:
self Nametag handle
result the resulting Nametag
Returns:
ESR_INVALID_ARGUMENT if self is null; ESR_OUT_OF_MEMORY if system is out of memory

ESR_ReturnCode(* SR_Nametag::destroy)(struct SR_Nametag_t *self)

Destroys a nametag.

Parameters:
self Nametag handle
Returns:
ESR_SUCCESS


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