LVCA_GetUserData

Get the call's User Data pointer.

LVCA_API BOOL WINAPI LVCA_GetUserData(HANDLE hCA, LPVOID*Param);

Return Value:

If successful, LVCA_GetUserData 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 will be set to the call's User Data pointer.

Notes:

The LVCA_GetUserData function will set the passed pointer to the call's User Data.  LVCA_SetUserData sets this pointer.  Each call maintains a unique pointer.  The User Data pointer is usually used to maintain a class or structure that holds call specific information.

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


Complete Help Topic List | Speech Platform Product Information