LV_SRE_GetStringPropertyEx

Gets various properties of string type for a specific port or the client properties used in initializing a new port.

Function

• int LV_SRE_GetStringPropertyEx(HPORT hport, int property, int target, char *value_str, int value_len_bytes, int *actual_value_len)

Parameters

hport

The port from which to get the property.

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.

target

Specifies whether the property is requested from a single port or from the client. Client values are the default values used when a new port is opened. Legal values are PROP_EX_TARGET_PORT and PROP_EX_TARGET_CLIENT.

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 input hport is not a valid one.

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

For PROP_EX_TARGET_CLIENT properties the hport value is ignored

From 10.0 to 10.2, the following properties are supported with the following targets:

• PROP_EX_TARGET_CLIENT
• PROP_EX_SRE_SERVERS
• PROP_EX_LICENSE_TYPE
• PROP_EX_LICENSE_SERVERS
• PROP_EX_TARGET_PORT
• None.

See Also

• Speech Port Properties
• LV_SRE_SetPropertyEx
• LV_SRE_GetIntPropertyEx
• LV_SRE_GetFloatPropertyEx
• LVSpeechPort::GetStringPropertyEx (C++ API)
• LVSpeechPort::GetClientStringPropertyEx (C++ API)