cl_GetCalled( )

Description | Termination Events | Cautions | Example | Errors | See Also

Name:	int cl_GetCalled(hDevice, pclEventData, pszCalled, iCalledSize)
Inputs:	long hDevice	Call Logging device handle
	CL_EVENTDATA* pclEventData	pointer to the call logging event data block
	char* pszCalled	pointer to the buffer for the called party number
	int iCalledSize	size of the buffer for the called party number
Returns:	0 on success -1 on failure -2 if call logging transaction already released
Includes:	cllib.h
Mode:	synchronous

Description

The cl_GetCalled( ) function gets the called party number, at event time. The value returned is that of the semantics-defined CALLED variable. The function returns the called party number as the number would have appeared at the time the CLEV_MESSAGE event was generated.

Parameter	Description
hDevice:	The device handle of the call logging device.
pclEventData:	A pointer to the call logging event data block obtained from sr_getevtdatap( ) while the function was processing a CLEV_MESSAGE event. See 1.5.2. Retrieving Event Data for more on the event data block.
pszCalled:	The pointer to the buffer into which the called party number is returned as an ASCIIZ string. If the called party number is not available, the function will return with an empty string.
iCalledSize:	The size of the buffer into which the called party number is returned, where the maximum size includes the terminating NUL of the ASCIIZ string.

Termination Events

None

Cautions

• The Call Logging API is not multi-thread safe. Call logging functions must be called within the same thread.
• This function can be called only while processing a CLEV_MESSAGE event.

Example

#include <cllib.h>  
#include <stdio.h>  
void GetCalled_WithinEventHandler(long hDevice, CL_EVENTDATA* pclEventData)  
{  
      int iRet;  
      char szCalled[32];  
      iRet = cl_GetCalled(hDevice, pclEventData, szCalled, sizeof(szCalled));  
      if (iRet != 0)  
      {  
             if (iRet == -2)  
             {  
                  printf("GetCalled_WithinEventHandler - Transaction already released\n");  
             }  
             else  
             {  
                  printf("GetCalled_WithinEventHandler - cl_GetCalled() failed\n");  
             }  
             return;  
      }  
      printf("Called party number is: \"%s\"\n", szCalled);  
}

Errors

If the function returns a value < 0, use the SRL Standard Attribute function ATDV_LASTERR( ) to obtain the error code or use ATDV_ERRMSGP( ) to obtain a descriptive error message. The error codes that can be returned by ATDV_LASTERR( ) are:

Error Code Value	Returned When
ECL_NULLPARAMETER	invalid NULL parameter
ECL_INVALIDCONTEXT	invalid event context
ECL_TRANSACTIONRELEASED	transaction already released
ECL_NOMEM	out of memory
ECL_INTERNAL	internal Call Logging error; cause unknown

See 2.2 Error Handling for more information about what kinds of errors can cause these codes to be returned.

See Also

• cl_ReleaseTransaction( )
• cl_GetVariable( )
• cl_PeekCalled( )

Click here to contact Dialogic Customer Engineering