TTS_GetStringParameterLength¶
Retorna o comprimento, em bytes, do valor de um parâmetro textual. Para recuperar o valor do parâmetro com a função TTS_GetStringParameter, deve-se alocar uma região de memória maior que o valor informado por esta função, de forma a acomodar o valor em si e o terminador nulo. Incrementar o valor informado em 1 byte é suficiente.
TTS_RETURN TTS_GetStringParameterLength( TTS_HANDLE handle, uint8_t pid,
uint32_t *length )
- handle
- Identificador da sessão.
- pid
- Identificador do parâmetro. A lista de parâmetros válidos pode ser consultada no Apêndice II – Parâmetros de configuração.
- length
- Ponteiro para a variável do tipo
uint32_t
que receberá o comprimento do valor do parâmetro. Esse objeto deve ser liberado pela aplicação através da função TTS_Free.
Essa função retorna um código de erro do tipo TTS_RETURN
. Se o valor retornado for igual a zero (TTS_OK
), a operação foi realizada com sucesso. Caso contrário, algum erro ocorreu durante a operação e o valor retornado corresponde a um dos códigos de erros descritos no Apêndice I.