NCM_GetCspCountryCode( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_GetCspCountryCode( szCountryName, ppncmCode )
Inputs:	char *szCountryName	country name
	NCMValue **ppncmCode	address of pointer where ISO country code will be output
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_GetCspCountryCode( ) function gets the country code for a country from the DCM Catalog. This function returns the ISO country code for a specified country via the address of a pointer passed to it. 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
szCountryName	ASCII-Z string containing country name
ppncmCode	address of the pointer that will point to the ISO country code

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

Example

#include "NCMApi.h" 
...
 
NCMValue *     pCode = NULL; 
//
// Execute
// 
NCMRetCode     ncmRc = NCM_GetCspCountryCode( "United States", &pCode ); 
if ( ncmRc == NCM_SUCCESS )
{
     ...
}
else
{     // Process error
     ...
} 
// Deallocate memory when through
// with it
NCM_Dealloc( pCode ); 
... 

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

Click here to contact Telecom Support Resources