NCM_DeleteEntry( )

---

Description | Cautions | Example | Error Codes

Name:	NCMRetCode NCM_DeleteEntry( pncmFamily, pncmDeviceUnique )
Inputs:	NCMFamily *pncmFamily	pointer to a structure containing a device family name
	NCMDevice *pncmDeviceUnique	pointer to a structure containing a unique device name
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_DeleteEntry( ) function removes configuration information from the system configuration.

This function's scope depends upon what values are passed for the NCMFamily and NCMDevice pointers.

• To remove configuration information for a device: NCMFamily and NCMDevice should point to an instantiated device.
• To remove configuration information for a family: NCMFamily should point to a valid family and NCMDevice should point to NULL.
• To remove all configuration information: NCMFamily and NCMDevice should both point to NULL.

The function parameters are defined as follows:

Parameter	Description
pncmFamily	pointer to the structure containing the family name; the value contained in the structure must be an instantiated family
pncmDeviceUnique	pointer to the structure containing the device's unique name, the unique device name must be the same name you used to add the device to the system configuration with the NCM_AddDevice( ) function

Cautions

This function removes configuration information instantiated in the current system configuration. It has no effect on the installable families, devices, and configuration parameters defined in the DCM Catalog. For more information about the distinction between the system configuration and the DCM Catalog, see Section 2.1, The DCM API Architecture.

Example

#include "NCMApi.h" 
... 
//
// Prepare inputs
// 
NCMFamily family;
family.name = "D/x1D";
family.next = NULL; 
NCMDevice device;
device.name = "D/41D-1";
device.next = NULL; 
//
// Execute
// 
// Delete a single device
NCMRetCode ncmRc = NCM_DeleteEntry( &family, &device ); 
if ( ncmRc == NCM_SUCCESS )
{
     ...
}
else
{      // Process error
     ...
} 
// Delete a family of devices
ncmRc = NCM_DeleteEntry( &family, NULL ); 
if ( ncmRc == NCM_SUCCESS )
{
     ...
}
else
{	// Process error
	...
} 
// Delete all devices
ncmRc = NCM_DeleteEntry( NULL, NULL ); 
if ( ncmRc == NCM_SUCCESS )
{
     ...
}
else
{     // Process error
     ...
} 
... 

Error Codes

Equate	Returned When
NCME_INVALID_INPUTS	the values of the parameters supplied are invalid
NCME_GENERAL	a problem occurred retrieving the data

Click here to contact Telecom Support Resources