NCM_IsEditable( )

---

Description | Cautions | Example | Error Codes

Name:	NCMRetCode NCM_IsEditable( pncmFamily, pncmDevice, pncmProperty, pncmVariable, pbEditable )
Inputs:	NCMFamily *pncmFamily	pointer to a structure containing a device family
	NCMDevice *pncmDevice	pointer to a structure containing a device name
	NCMProperty *pncmProperty	pointer to a structure containing a property section
	NCMVariable *pncmVariable	pointer to a structure containing a configuration parameter
	BOOL *pbEditable	pointer to a Boolean where output is placed
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_IsEditable( ) function determines if a configuration parameter can be edited.

This function queries the DCM Catalog to determine if the passed configuration parameter can be edited. If the configuration parameter can be edited, the address referenced by the pbEditable pointer is set to TRUE; otherwise it is set to FALSE.

The function parameters are defined as follows:

Parameter	Description
pncmFamily	pointer to the structure containing the family name; the value of the structure must be an installable family (see Cautions below)
pncmDevice	pointer to the structure containing a device name; the device name can be either a device model name or a unique device 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)
pncmProperty	pointer to the structure containing the property name; the value of the structure must be an installable property (see Cautions below)
pncmVariable	pointer to the structure containing the configuration parameter; the value of the structure must be an installable configuration parameter (see Cautions below)
pbEditable	a pointer to a Boolean specifying that the configuration parameter can be edited (TRUE) or cannot be edited (FALSE)

Cautions

The pncmFamily, pncmProperty, and pncmVariable pointers must reference information that is valid in the current DCM Catalog.

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; 
NCMProperty property;
property.name = "System";
property.next = NULL; 
NCMVariable variable;
variable.name = "D41DAddress";
variable.next = NULL; 
BOOL     bEditable = TRUE; 
//
// Execute
// 
NCMRetCode     ncmRc = NCM_IsEditable( &family, &device, &property,
                                             &variable, &bEditable ); 
if ( ncmRc == NCM_SUCCESS )
{
     if ( bEditable == TRUE )
     {
          ...
     }
     else
     {
          ...
     }
}
else
{     // Process error
     ...
}
... 

Error Codes

Equate	Returned When
NCME_NO_INF	the DCM Catalog could not be found
NCME_MEM_ALLOC	memory could not be allocated to perform the function
NCME_GENERAL	a problem occurred retrieving the data
NCME_INVALID_INPUTS	the values of the parameters supplied are invalid

Click here to contact Telecom Support Resources