NCM_SetValue( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_SetValue( pncmFamily, pncmDeviceUnique, pncmProperty, pncmVariable, pncmValue )
Inputs:	NCMFamily *pncmFamily	pointer to a structure containing a device family
	NCMDevice *pncmDeviceUnique	pointer to a structure containing unique device name
	NCMProperty *pncmProperty	pointer to a structure containing a property section
	NCMVariable *pncmVariable	pointer to a structure containing a configuration parameter
	NCMValue *pncmValue	pointer to a structure containing the new value
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_SetValue( ) function sets a configuration parameter value.

For more information about using this function, see Section 2.3.3, Reading and Writing Configuration Parameter Values.

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 (see Cautions below.)
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
pncmProperty	pointer to the structure containing the property name; the value contained in the structure must be an instantiated property (see Cautions below)
pncmVariable	pointer to the structure containing the configuration parameter name; the value contained in the structure must be an instantiated configuration parameter (see Cautions below)
pncmValue	pointer to the value to be set

Cautions

This function enables you to set the value of a configuration parameter in the system configuration. It does not enable you to add configuration parameter values to 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.

The DCM API allocates memory for the data returned by this function. To avoid memory leaks, the client application must deallocate this memory by calling the NCM_Dealloc( ) or NCM_DeallocValue( ) function.

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; 
NCMValue value;
value.name = "d0000";
value.next = NULL; 
//
// Execute
// 
NCMRetCode     ncmRc = NCM_SetValue( &family, &device, &property,
                                         &variable, &value ); 
if ( ncmRc != NCM_SUCCESS )
{     // Process error
     ...
} 
... 

Error Codes

Equate	Returned When
NCME_INVALID_INPUTS	the values of the parameters supplied are invalid
NCME_BAD_DATA_TYPE	the data type of the variable is incorrect or indeterminable
NCME_CTBB_DEVICE_DETECTED	error configuring the TDM bus
NCME_SP	invalid state transition
NCME_BAD_DATA_LOC	the data destination is invalid or indeterminate

See Also

• NCM_AddDevice( )
• NCM_GetInstalledDevices( )
• NCM_GetInstalledFamilies( )
• NCM_GetValue( )
• NCM_GetValueEx( )
• NCM_SetValueEx( )

Click here to contact Telecom Support Resources