cl_GetSemanticsStateCount( )

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

Name:	int cl_GetSemanticsStateCount(hDevice, piSemanticsStateCount)
Inputs:	long hDevice	call logging device handle
	int* piSemanticsStateCount	pointer to returned number
Returns:	0 on success -1 on failure
Includes:	cllib.h
Mode:	synchronous

Description

The cl_GetSemanticsStateCount( ) function returns the number of semantics states defined in the protocol-specific semantics for a specified call logging device. Semantics states, such as dialing, connected or disconnected, represent the current status of the monitored call.

The list of semantics states (count, names, and indexes) is protocol-dependent. Semantics states are indexed from 0 to the number of semantics states minus one.

Parameter	Description
hDevice:	The device handle of the call logging device.
piSemanticsStateCount:	The pointer to the returned number of semantics states for this call logging device.

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 GetSemanticsStates(void)  
{  
      int nStates;  
      int iState;  
      char szState[64];  
      if (g_hDevice != EV_ANYDEV)  
      {  
            if (cl_GetSemanticsStateCount(g_hDevice, &nStates) != 0)  
            {  
                  printf("GetSemanticsStates - cl_GetSemanticsStateCount() failed\n");  
                  return;  
            }  
            printf("There are %i semantics states:\n", nStates);  
            for (iState = 0 ; (iState < nStates) ; ++iState)  
            {  
                  if (cl_GetSemanticsStateName(g_hDevice, iState, szState, sizeof(szState)) != 0)  
                  {  
                        printf("GetSemanticsStates - cl_GetSemanticsStateName() failed\n");  
                        return;  
                  }  
                  printf("%i: \"%s\"\n", iState, szState);  
            }  
      }  
}

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_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_GetSemanticsStateName( )

Click here to contact Dialogic Customer Engineering