Returns the specified configuration setting value for "int" type options in the LV_TTS interface.
Function
- LV_TTS_RETURN_CODE LV_TTS_GetIntPropertyEx(HTTSCLIENT client_handle, int property, int target, int * pvalue);
Parameters
client_handle
Handle to the TTS client object.
property
One of several enumerated properties whose value is of int 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 a single TTS client port object
PROP_EX_TARGET_CLIENT -- obtains the global value for the property.
pvalue
Pointer to an integer variable into which the queried value is to be stored.
Return Values
LV_SUCCESS
No errors.
LV_INVALID_TTS_HANDLE
The input TTS client handle is not a valid one. 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
The only supported targets are PROP_EX_TARGET_PORT and PROP_EX_TARGET_CLIENT.