NCM_RemoveThirdPartyDevice( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_RemoveThirdPartyDevice(pDeviceName)
Inputs:	NCMDevice *pDeviceName	pointer to the third party device name that will be removed
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_RemoveThirdPartyDevice( ) function deletes a third party device's TDM bus configuration information from the Intel® Dialogic system. This function also releases all time slots that are allocated to the deleted third party device.

Note: If the third party device you are removing is the system's primary clock master, you must define a new primary clock master before calling the NCM_RemoveThirdPartyDevice( ) function.

The function parameters are defined as follows:

Parameter	Description
pDeviceName	pointer to the data structure containing the name of the third party device being deleted. The device name must be the same name you used to add the third party device to the system configuration with the NCM_AddThirdPartyDevice( ) function

Cautions

You cannot set the pDeviceName parameter to NULL.

Example

#include "NCMApi.h" 
   NCMDevice deviceName;
   Char DeviceString[] = "ThirdPartyDevice-XYZ#1";
   deviceName.name = (char *)DeviceString;
   deviceName.next = NULL; 
   //call NCM API function
   ncmRc = NCM_RemoveThirdPartyDevice(deviceName); 
   if (ncmRc !=NCM_SUCCESS)
   {
      /*process error*/
   }
   else
   {
      /*process success*/
   } 
... 

Error Codes

Equate	Returned When
NCME_INVALID_INPUTS	invalid inputs
NCME_INVALID_THIRDPARTY_DEVICE	specified third party device does not exist
NCME_CTBB_LIB	CTBBface.dll file either cannot be found in the system or is the incorrect version
NCME_CTBB_DEVICESDETECTED	re-detection of devices failed

See Also

• NCM_AddThirdPartyDevice( )

Click here to contact Telecom Support Resources