NCM_GetCspCountries( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_GetCspCountries( ppncmCountries )
Inputs:	NCMValue **ppncmCountries	address of pointer where countries will be output
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_GetCspCountries( ) function gets a list of supported countries from the DCM Catalog. For more information about modifying country-specific parameter values, see Section 2.7, Working with Country Specific Parameters.

This function fills a pointer to a pointer with the beginning address of a list of countries. The list represents those countries for which Intel® Dialogic devices may be configured.

The function parameter is defined as follows:

Parameter	Description
ppncmCountries	address of the pointer to the list to be filled with structures containing the countries

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" 
... 
NCMValue *     pCountries = NULL; 
//
// Execute
// 
NCMRetCode     ncmRc = NCM_GetCspCountries( &pCountries ); 
if ( ncmRc == NCM_SUCCESS )
{
     NCMValue * pCurrCountries = pCountries;
     while ( pCurrCountries != NULL )
     {     // Process list
          ...     
          pCurrCountries = pCurrCountries->next;
     }
}
else
{     // Process error
...
} 
// Deallocate memory when through
// with it
NCM_Dealloc( pCountries );
... 

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_GetCspCountryCode( )
• NCM_GetCspCountryName( )
• NCM_DeallocValue( )
• NCM_Dealloc( )

Click here to contact Telecom Support Resources