Browse
 
Tools
Rss Categories

LV_TTS_SetPropertyEx

Reference Number: AA-01008 Views: 2952 0 Rating/ Voters

Set optional configuration properties for the LV_TTS interface.

Function

  • LV_TTS_RETURN_CODE LV_TTS_SetPropertyEx(HTTSCLIENT client_handle, int property, int property_value_type, void * pvalue, int target);

Parameters

client_handle

Handle to the active TTS client object.

property

One of several enumerated properties, described in TTS Client Properties.

property_value_type

The value type of the property being set. Legal values are:

PROP_EX_VALUE_TYPE_INT

PROP_EX_VALUE_TYPE_INT_PTR

PROP_EX_VALUE_TYPE_STRING

PROP_EX_VALUE_TYPE_FLOAT_PTR

Each property has a set of legal set of value types. See TTS Client Properties for value types available for each property.

pvalue

A pointer to the new value for the property specified. pvalue will be reinterpreted according to the property_value_type provided.

target

The portion of the API that this property is set for. Legal values are:

PROP_EX_TARGET_PORT -- pvalue affects a single TTS client port object

PROP_EX_TARGET_CLIENT -- pvalue applies globally, affects all ports in the application.

Return Values

LV_SUCCESS

No errors; the property was successfully set.

LV_INVALID_TTS_HANDLE

The specified TTS client handle is not a valid one.

LV_INVALID_PROPERTY

The specified property is invalid.

LV_INVALID_PROPERTY_VALUE_TYPE

The specified property_value_type is not valid for the specified property.

LV_INVALID_PROPERTY_TARGET

The specified property is not valid for the specified target.

LV_INVALID_API_PARAMETER or LV_FAILURE

The provided pvalue is not valid, not permitted or not in acceptable range.

LV_EXCEPTION

An exception occurred while processing the request.

Remarks

The value of client_handle is ignored when the target specified is PROP_EX_TARGET_CLIENT, so you may simply pass in NULL for client_handle.

The only supported targets are PROP_EX_TARGET_PORT and PROP_EX_TARGET_CLIENT.