Browse
 
Tools
Rss Categories

LVTTSClient::GetStringPropertyEx

Reference Number: AA-01027 Views: 2447 0 Rating/ Voters

Returns the specified configuration setting value for "string" type options in the associated LVTTSClient instance.

Function

  • LV_TTS_RETURN_CODE GetStringPropertyEx( int property, int target, 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.

target

The portion of the API for which this property is being queried. Legal values are:

PROP_EX_TARGET_PORT -- obtains the property value set for the associated LVTTSClient instance

PROP_EX_TARGET_CLIENT -- obtains the global value for the property.

value_str

The address of a character buffer variable 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 for the specified target.

LV_FAILURE

The specified target is neither PROP_EX_TARGET_PORT nor PROP_EX_TARGET_CLIENT.

LV_EXCEPTION

An exception occurred 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.

The only supported targets are PROP_EX_TARGET_PORT and PROP_EX_TARGET_CLIENT. If you are specifying PROP_EX_TARGET_CLIENT, it is suggested that you use LVTTSClient::GetClientStringPropertyEx instead.