Returns the specified configuration setting value for "float" type options in the associated LVTTSClient instance.
Function
- LV_TTS_RETURN_CODE GetFloatPropertyEx(int property, int target, float &pvalue)
Parameters
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 the associated LVTTSClient instance
PROP_EX_TARGET_CLIENT -- obtains the global value for the property.
pvalue
Reference to a float type variable into which the queried value is to be copied.
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
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::GetClientFloatPropertyEx instead.
