LVTTSClient::GetClientStringPropertyEx

Query global configuration settings for string type options int the application.

Function

• static LV_TTS_RETURN_CODE GetClientStringPropertyEx(
• int property,
• char *value_str,
• int value_len_bytes,
• int *actual_value_len)

Parameters

property

One of several enumerated properties whose value is of string type, described in TTS Client Properties.

value_str

A char buffer to store the queried value in.

value_len_bytes

Maximum size of the provided value_str buffer in bytes.

actual_value_len

The size of buffer in value_str actually used to store the queried value.

Return Values

LV_SUCCESS

No errors.

LV_INVALID_TTS_HANDLE

The TTS client handle is invalid (either Initialize has not been called or Destroy has already been called). Only returned if target is set to PROP_EX_TARGET_PORT.

LV_INVALID_PROPERTY

The specified property is invalid.

LV_INVALID_PROPERTY_TARGET

The specified property is not valid as a global setting.

LV_EXCEPTION

An exception occured while processing the request.

Remarks

If value_str is set to NULL or value_len_bytes is set to zero, no copying is performed and on a successful return, the value returned in actual_value_len indicates the total size of value_str required to completely store the queried value.

See Also

• TTS Client Properties
• LVTTSClient::GetStringPropertyEx
• LVTTSClient::GetClientIntPropertyEx
• LVTTSClient::GetClientFloatPropertyEx
• LVTTSClient::SetClientPropertyEx
• LV_TTS_GetStringPropertyEx (C API)