cl_PeekChannel( )

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

Name:	int cl_PeekChannel(hDevice, idTransaction, pszChannel, iChannelSize)
Inputs:	long hDevice	call logging device handle
	long idTransaction	call logging transaction ID
	char* pszChannel	pointer to buffer into which channel number is returned
	int iChannelSize	size of buffer into which channel 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_PeekChannel( ) function gets the channel number as it was observed at the time the function was called. The cl_PeekChannel( ) function returns the value of the semantics-defined CHANNEL variable.

Parameter	Description
hDevice:	The device handle of the call logging device.
idTransaction:	The call logging transaction ID.
pszChannel:	The pointer to the buffer into which the channel number is returned. The channel number is returned as an ASCIIZ string.
iChannelSize:	The size of the buffer into which the channel 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.
• The range of channel numbers depends on the semantics rules of the CCS protocol used and does not necessarily match Dialogic device name numbering. For example, E-1 ISDN channel numbers range from 1 to 15 and from 17 to 31, while the Dialogic device names on an E-1 board range from "dtiBxT1" to "dtiBxT30".

Example

#include <srllib.h>  
#include <cllib.h>  
#include <stdio.h>  
/* The Call Logging Device Handle */  
extern long g_hDevice;  
void PeekChannel(long idTransaction)  
{  
      int iRet;  
      char szChannel[8];  
      if (g_hDevice != EV_ANYDEV)  
      {  
            iRet = cl_PeekChannel(g_hDevice, idTransaction, szChannel, sizeof(szChannel));  
            if (iRet != 0)  
            {  
                  if (iRet == -2)  
                  {  
                        printf("PeekChannel - Transaction already released\n");  
                  }  
                  else  
                  {  
                        printf("PeekChannel - cl_PeekChannel() failed\n");  
                  }  
                  return;  
            }  
            printf("Bearer channel number is: \"%s\"\n", szChannel);  
      }  
}

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_GetChannel( )
• cl_PeekVariable( )
• cl_ReleaseTransaction( )

Click here to contact Dialogic Customer Engineering