cl_GetUsrAttr( )

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

Name:	int cl_GetUsrAttr(hDevice, ppUsrAttr)
Inputs:	long hDevice	call logging device handle
	void** ppUsrAttr	pointer to returned pointer to user-defined attribute
Returns:	0 on success -1 on failure
Includes:	cllib.h
Mode:	synchronous

Description

The cl_GetUsrAttr( ) function returns the user-defined attribute for a call logging device. The user-defined attributes are set using the cl_SetUsrAttr( ) function. If NULL was specified as the pUsrAttr parameter of the cl_Open( ) function and if the cl_SetUsrAttr( ) function has not been called for the specified call logging device, NULL will be returned.

Parameter	Description
hDevice:	The device handle of the call logging device.
ppUsrAttr:	The pointer to the returned pointer to the user-defined attribute for the specified 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.
• The application is responsible for freeing the memory allocated to store the user-defined attribute.

Example

#include <cllib.h>  
#include <stdio.h>  
typedef struct  
{  
      const char*   pszProtocol;  
      const char*   pszNetworkDeviceName;  
      const char*   pszUserDeviceName;  
} DEVICEUSRATTR;  
DEVICEUSRATTR* GetDeviceUsrAttr(long hDevice)  
{  
      DEVICEUSRATTR* pDeviceUsrAttr;  
      if (cl_GetUsrAttr(hDevice, (void**)&pDeviceUsrAttr) != 0)  
      {  
            printf("GetDeviceUsrAttr - cl_GetUsrAttr() failed\n");  
            return NULL;  
      }  
      return pDeviceUsrAttr;  
}

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_Open( )
• cl_SetUsrAttr( )

Click here to contact Dialogic Customer Engineering