Browse
 
Tools
Rss Categories

LVSpeechPort::SetClientPropertyExPermanent

Reference Number: AA-00811 Views: 1722 0 Rating/ Voters

Sets configuration properties for the client application and marks the properties' changes as permanent (to eventually write the changes to config file by calling CommitClientPropertySettings). The function is similar to SetClientPropertyEx (called with PROP_EX_TARGET_CLIENT as the target), except that this also marks the change as permanent.

Function

  • static int SetClientPropertyExPermanent(int property, int value_type, void* pvalue)

Parameters

property

Which property to modify. See Speech Port Properties for list of properties.

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 Speech Port 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 value_type provided.

Return Values

LV_SUCCESS

No errors. Property was set to specified value

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_VALUE

The value is invalid for the designated property (e.g. out of range).

LV_INVALID_PROPERTY_VALUE_TYPE

The property's type is incompatible with the declared type.

LV_INVALID_PROPERTY

The property does not exist.

LV_EXCEPTION

An exception occurred while processing the request.

Remarks

This function is available in versions 10.4 or later. CommitClientPropertySettings must be called along with this function, but it only needs to be called once during the program, since it serves to commit the changes made by all previous calls of this function.

See Also