LVCA_SetUserData

Sets the call's User Data pointer.

LVCA_API BOOL WINAPI LVCA_SetUserData(HANDLE hCA, LPVOID Param);

Return Value:

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

Supported on Events:

CAMSG_CALLSTART

CAMSG_CALLSTOP

CAMSG_ENTERMODULE

CAMSG_REC_BEFORE_CONFIRM

CAMSG_REC_AFTER_CONFIRM

CAMSG_TIMEOUT CAMSG_ERROR

Params:

hCA (IN) The handle given by the event callback.

Param (OUT) The pointer which the call’s User Data will be set to.

Notes:

The LVCA_SetUserData function will set the call's User Data equal to the passed parameter pointer.  The function LVCA_GetUserData retrieves this pointer.  The most appropriate place to use this function is within the first function the Platform always calls, LV_Call_Start.

Warning:  This function is equivalent to calling LVCA_SetUserDataA with the identifier parameter pointing to an empty string.

Complete Help Topic List | Speech Platform Product Information