NCM_GetCspFeaturesVariables( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_GetCspFeaturesVariables( szCountryCode, ppncmVariables )
Inputs:	char *szCountryCode	country code
	NCMVariable **ppncmVariables	address of pointer where the pointer to a comma separated list of country specific configuration parameters will be stored
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_GetCspFeaturesVariables( ) function gets values for country specific configuration parameters for a specified country from the DCM Catalog.

The function parameters are defined as follows:

Parameter	Description
szCountryCode	ASCII-Z string containing ISO country code; for information about how to find the country code, see Section 2.7, Working with Country Specific Parameters.
ppncmVariables	address of the pointer that will point to the "Features" components

Cautions

The country specific configuration parameters retrieved for the Country property vary with the value of the Country parameter. For all other properties, the configuration parameters are retrieved with the NCM_GetVariables( ) function; the configuration parameters retrieved in this way are those that are applicable to the device name input to this function. For example, the System property for a D/41D device contains the D41DAddress, D41DInterrupt, and ISABusWidth parameters, whereas the same property for a D/240SC device contains BLTAddress, BLTInterrupt, BLTId, and ISABusWidth. In the case of country-specific configuration parameters, however, it is the value of the Country configuration parameter that determines which country-specific configuration parameters belong to the property.

The information provided by this function is limited to the DCM Catalog. To retrieve information that is instantiated in your system configuration, use NCM_GetCspFeaturesValue( ).

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" 
... 
NCMVariable *     pVariables = NULL; 
//
// Execute
// 
NCMRetCode     ncmRc = NCM_GetCspFeaturesVariables( "US", &pVariables ); 
if ( ncmRc == NCM_SUCCESS )
{
     NCMVariable * pCurrVariables = pVariables;
     while ( pCurrVariables != NULL )
     {
          ...
          pCurrVariables = pCurrVariables->next;
     }
}
else
{     // Process error
     ...
} 
// Deallocate memory when through
// with it
NCM_Dealloc( pVariables );
... 

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

Click here to contact Telecom Support Resources