LVCA_SetCustomStringDataA/LVCA_SetCustomStringDataW

Use this function to set a custom string that will be stored by the Platform. The custom string consists of a property name and a value associated with that property. You can use LVCA_GetCustomStringData to retrieve the value using the property name. For instance, you might use SetCustomStringData to store a username, and then later retrieve it.

LVCA_API BOOL WINAPI LVCA_SetCustomStringDataA(HANDLE hCA, LPCSTR Property, LPCSTR Value, LONG size);

LVCA_API BOOL WINAPI LVCA_SetCustomStringDataW(HANDLE hCA, LPCSTR Property, LPCSTR Value, LONG size);

You can also use SetCustomStringData to control various hardware parameters, affecting how the Platform will treat DTMF and speech entry.

Return Value:

If successful, LVCA_SetCustomStringData returns true.  If false is returned, call LVCA_GetLastCallError to retrieve the error code and message.

Supported on Events:

CAMSG_CALLSTART

CAMSG_ENTERMODULE

CAMSG_REC_BEFORE_CONFIRM

CAMSG_REC_AFTER_CONFIRM

Params:

hCA (IN): the handle to the call.

Property (IN): the property name; the name of the custom string.

Value (IN): the value stored.

Example:

LVCA_SetCustomStringDataA(hCA, "USER_ID", "user");

Complete Help Topic List | Speech Platform Product Information