LVSpeechPort::GetClientStringPropertyEx

Gets various client properties of type String used in initializing a new port.

Function

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

Parameters

property

Selects the property whose value needs to be returned. This function can return the property value for Speech Port Properties with Value Type of PROP_EX_VALUE_TYPE_STRING.

value_str

A buffer of length value_len_bytes for the property to be written to

value_len_bytes

The length of the buffer allocated for value_str.

actual_value_len

The actual length of the property string returned.

Return Values

LV_SUCCESS

No errors.

LV_FAILURE

The property cannot not be retrieved.

LV_INVALID_HPORT

The port is not valid (either CreateClient has not been called or DestroyClient has been called prior to this call).

LV_INVALID_PROPERTY_TARGET

The property cannot be retrieved for the specified target.

LV_INVALID_PROPERTY

The property does not exist.

LV_EXCEPTION

An exception occured while processing the request.

Remarks

This is a static function to get client properties without opening a port

To get port specific properties use GetIntPropertyEx, GetFloatPropertyEx or GetStringPropertyEx

From 10.0 to 10.2, the following properties are supported:

• PROP_EX_SRE_SERVERS
• PROP_EX_LICENSE_TYPE
• PROP_EX_LICENSE_SERVERS

See Also

• Speech Port Properties
• LVSpeechPort::SetPropertyEx
• LVSpeechPort::SetClientPropertyEx
• LVSpeechPort::GetIntPropertyEx
• LVSpeechPort::GetFloatPropertyEx
• LVSpeechPort::GetStringPropertyEx
• LVSpeechPort::GetClientIntPropertyEx
• LVSpeechPort::GetClientFloatPropertyEx
• LV_SRE_GetStringPropertyEx (C API)