cl_GetVariable( )

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

Name:	int cl_GetVariable(hDevice, pclEventData, pszVariableName, pszVariable, iVariableSize)
Inputs:	long hDevice	call logging device handle
	CL_EVENTDATA* pclEventData	pointer to call logging event data block
	const char* pszVariableName	pointer to ASCIIZ string that specifies name of variable
	char* pszVariable	pointer to buffer into which the value of the variable is returned
	int iVariableSize	size of buffer into which the value of the variable is returned
Returns:	0 on success -1 on failure -2 if call logging transaction already released
Includes:	cllib.h
Mode:	synchronous

Description

The cl_GetVariable( ) function returns the semantics-defined variable as it would have appeared at the time the CLEV_MESSAGE event was generated. The current list of semantics variables common to all protocols is (case-sensitive) CALLED, CALLING, CHANNEL. Additional protocol-specific variable names can be defined by the semantics.

Parameter	Description
hDevice:	The device handle of the call logging device.
pclEventData:	The pointer to the call logging event data block obtained from sr_getevtdatap( ) while the function was processing a CLEV_MESSAGE event. See Section 1.5.2. Retrieving Event Datafor more information.
pszVariableName:	The pointer to the ASCIIZ string that specifies the name of the semantics-defined variable.
pszVariable:	The pointer to the buffer into which the value of the semantics-defined variable is returned. The value is returned as an ASCIIZ string.
iVariableSize:	The size of the buffer into which the value of the semantics-defined variable 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.
• This function can only be called while processing a CLEV_MESSAGE event.

Example

#include <cllib.h>  
#include <stdio.h>  
void GetVariable_WithinEventHandler(long hDevice, CL_EVENTDATA* pclEventData)  
{  
      int iRet;  
      char szCalled[32];  
      char szCalling[32];  
      char szChannel[8];  
      iRet = cl_GetVariable(hDevice, pclEventData, "CALLED", szCalled, sizeof(szCalled));  
      if (iRet != 0)  
      {  
            if (iRet == -2)  
            {  
                  printf("GetVariable_WithinEventHandler - Transaction already released\n");  
            }  
            else  
            {  
                  printf("GetVariable_WithinEventHandler - cl_GetVariable() failed\n");  
            }  
      }  
      else  
      {  
            printf("Called party number is: \"%s\"\n", szCalled);  
      }  
      iRet = cl_GetVariable(hDevice, pclEventData, "CALLING", szCalling, sizeof(szCalling));  
      if (iRet != 0)  
      {  
            if (iRet == -2)  
            {  
                  printf("GetVariable_WithinEventHandler - Transaction already released\n");  
            }  
            else  
            {  
                  printf("GetVariable_WithinEventHandler - cl_GetVariable() failed\n");  
            }  
      }  
      else  
      {  
            printf("Calling party number is: \"%s\"\n", szCalling);  
      }  
      iRet = cl_GetVariable(hDevice, pclEventData, "CHANNEL", szChannel, sizeof(szChannel));  
      if (iRet != 0)  
      {  
            if (iRet == -2)  
            {  
                  printf("GetVariable_WithinEventHandler - Transaction already released\n");  
            }  
            else  
            {  
                  printf("GetVariable_WithinEventHandler - cl_GetVariable() failed\n");  
            }  
      }  
      else  
      {  
            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_INVALIDCONTEXT	invalid event context
ECL_TRANSACTIONRELEASED	transaction already released
ECL_INVALIDPARAMETER	invalid parameter
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_GetCalling( )
• cl_GetChannel( )
• cl_PeekVariable( )
• cl_ReleaseTransaction( )

Click here to contact Dialogic Customer Engineering