NCM_GetCspFeaturesValueRange( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_GetCspFeaturesValueRange (szCountryCode, pncmVariable, ppncmRange)
Inputs:	char *szCountryCode	country code
	NCMVariable *pncmVariable	pointer to a country specific configuration parameter
	NCMValue **ppncmRange	address of pointer where range will be output
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_GetCspFeaturesValueRange( ) function gets the value range for a country specific configuration parameter.

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
pncmVariable	pointer to the country specific configuration parameter for which a range will be returned
ppncmRange	address of the pointer that will contain the value range of the country specific configuration parameter

Cautions

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
// 
NCMVariable          variable;
variable.name = "Receive Gain";
variable.next = NULL; 
NCMValue *          pRange = NULL; 
//
// Execute
// 
NCMRetCode     ncmRc = NCM_GetCspFeaturesValueRange( "US", &variable, 
                                                           &pRange );
if ( ncmRc == NCM_SUCCESS )
{
     NCMValue * pCurrRange = pRange;
     while ( pCurrRange != NULL )
     {
          ...
          pCurrRange = pCurrRange->next;
     }
}
else
{     // Process error
     ...
} 
// Deallocate memory when through
// with it
NCM_Dealloc( pRange );
... 

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_GetCspFeaturesValue( )
• NCM_GetCspFeaturesVariables( )
• NCM_DeallocValue( )

Click here to contact Telecom Support Resources