NCM_GetCspFeaturesValue( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_GetCspFeaturesValue(szCountryCode, szFeatures, pncmVariable, ppncmValue)
Inputs:	char *szCountryCode	pointer to a country code
	char *szFeatures	pointer to a comma-separated list of country specific configuration parameters
	NCMVariable *pncmVariable	pointer to a country specific configuration parameter listed in szFeatures
	NCMValue **ppncmValue	address of the pointer to the value of the variable specified by pncmVariable
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_GetCspFeaturesValue( ) function gets a country-specific parameter value from within the pointer to a comma-separated list of country specific configuration parameters contained in the Features configuration parameter. The value is either extracted from the string of values passed in szFeatures or found in the current system configuration.

For more information about modifying country-specific parameter values, see Section 2.7, Working with Country Specific Parameters.

The function parameters are defined as follows:

Parameter	Description
szCountryCode	ASCII-Z string containing ISO country code
szFeatures	ASCII-Z string containing either a pointer to a comma-separated list of country specific configuration parameters or NULL
pncmVariable	pointer to the country specific configuration parameter for which a value will be returned
ppncmValue	address of the pointer that will contain the value of the country specific configuration parameter value

Whether the country-specific configuration parameter value this function gets is from the DCM Catalog or the system configuration depends on the value of szFeatures:

• To retrieve the default country-specific configuration parameter value from the DCM Catalog: set szFeatures to an ASCII-Z string containing a pointer to a comma-separated list of country-specific configuration parameters.
• To retrieve the country-specific configuration parameter value from the system configuration: set szFeatures to NULL.

Cautions

The set of country-specific configuration parameters retrieved by NCM_GetCspFeaturesValue( ) is determined by the value of the Country parameter.

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 the NCM_DeallocValue( ) function.

Example

#include "NCMApi.h" 
... 
//
// Prepare inputs
// 
NCMVariable          variable;
variable.name = "Receive Gain";
variable.next = NULL; 
NCMValue *          pValue = NULL; 
//
// Execute
// 
NCMRetCode          ncmRc = NCM_GetCspFeaturesValue( "US", "RXGAIN_0,
                                   FREQRES_HIGH", &variable, &pValue );
if (ncmRc == NCM_SUCCESS)
{
     ...
}
else
{     // Process error
     ...
} 
// Deallocate memory when through
// with it
NCM_Dealloc( pValue ); 
... 

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_DATA_NOT_FOUND	requested data not found in NCM data storage
NCME_INVALID_INPUTS	the values of the parameters supplied are invalid

See Also

• NCM_Dealloc( )
• NCM_DeallocValue( )
• NCM_GetCspFeaturesValueRange( )
• NCM_GetCspFeaturesVariables( )

Click here to contact Telecom Support Resources