LVCA_GetCustomStringDataA

LVCA_GetCustomStringDataW

Use this function to retrieve a custom string and its associated value. There are a number of predefined strings you can use, or you can add new ones using LVCA_SetCustomStringData.

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

Return Value

This function returns true if successful, otherwise false will be 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 (OUT): the value retrieved.
• Size (OUT): the size of the value.

Notes:

The following property names contain predefined values you can access using LVCA_GetCustomStringData. Using LVCA_SetCustomStringData, you can set other values and access them using GetCustomStringData.

LVCA_KEY_CALLTYPE

Possible values: LVCA_VALUE_CALLTYPE_INBOUND or LVCA_VALUE_CALLTYPE_OUTBOUND. This represents whether the call is inbound or outbound.

LVCA_KEY_ANI

Possible values: a string that contains the Automatic Number Identification, i.e. the outbound caller ID.

LVCA_KEY_DNIS

Possible values: a string that contains the Dialed Number Identification Service, i.e. the inbound caller ID.

LVCA_KEY_CALLERIDMSG

Possible values: a string containing additional caller ID information.

LVCA_KEY_CURRENT_MODULE_NAME

Possible values: a string that contains the name of the Platform module the call is currently in.

LVCA_KEY_PLATFORM_DIRECTORY

Possible values: a string that contains the Platform's installation directory.

ADJUSTED_CONF_SCORE

An alternate confidence score for strings of digits. It adds the lowest confidence score of an individual digit to the average confidence score of the set of digits, and divides that sum by two. This means that the confidence score for the set of digits will be weighted more heavily toward the lowest score.