cl_PeekCalled( )

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

Name:	int cl_PeekCalled(hDevice, idTransaction, pszCalled, iCalledSize)
Inputs:	long hDevice	call logging device handle
	long idTransaction	call logging transaction ID
	char* pszCalled	pointer to buffer into which called party number is returned
	int iCalledSize	size of buffer into which called party number is returned
Returns:	0 on success -1 on failure -2 if call logging transaction already released
Includes:	cllib.h
Mode:	synchronous

Description

The cl_PeekCalled( ) function gets the called party number as it was observed at the time the function was called. The cl_PeekCalled( ) function returns the value of the semantics-defined CALLED variable.

Parameter	Description
hDevice:	The device handle of the call logging device.
idTransaction:	The call logging transaction ID.
pszCalled:	The pointer to the buffer into which the called party number is returned. The called party number is returned as an ASCIIZ string. If the called party number is not available, the function returns with an empty string.
iCalledSize:	The size of the buffer into which the called party number is returned, where maximum size includes the terminating NUL of the returned 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.

Example

#include <srllib.h>  
#include <cllib.h>  
#include <stdio.h>  
/* The Call Logging Device Handle */  
extern long g_hDevice;  
void PeekCalled(long idTransaction)  
{  
      int iRet;  
      char szCalled[32];  
      if (g_hDevice != EV_ANYDEV)  
      {  
            iRet = cl_PeekCalled(g_hDevice, idTransaction, szCalled, sizeof(szCalled));  
            if (iRet != 0)  
            {  
                  if (iRet == -2)  
                  {  
                        printf("PeekCalled - Transaction already released\n");  
                  }  
                  else  
                  {  
                        printf("PeekCalled - cl_PeekCalled() 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_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_GetCalled( )
• cl_PeekVariable( )
• cl_ReleaseTransaction( )

Click here to contact Dialogic Customer Engineering