NCM_GetThirdPartyDeviceBusCaps( )

---

Description | Cautions | Example | Error Codes

Name:	NCMRetCode NCM_GetThirdPartyDeviceBusCaps(pDeviceName, pTDMBusCapabilities)
Inputs:	NCMDevice *pDeviceName	third party device name
	NCM_TDM_BUSCAPS *pTDMBusCapabilities	pointer to the TDM bus capabilities of the third party device
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_GetThirdPartyDeviceBusCaps( ) function returns the TDM bus capabilities of a third party device. The TDM bus capabilities of a third party device is defined when the NCM_AddThirdPartyDevice( ) function is called to add the device to the system.

The function parameters are defined as follows:

Parameter	Description
pDeviceName	pointer to the data structure containing the name of a third party device. 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
pTDMBusCapabilities	pointer to the NCM_TDM_BUSCAPS data structure that holds the devices TDM bus capabilities

Cautions

You cannot set the pDeviceName parameter to NULL.

Example

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

Error Codes

Equate	Returned When
NCME_INALID_INPUTS	invalid inputs

Click here to contact Telecom Support Resources