PREV TOC HOME INDEX NEXT


NCM_GetCspCountryName( )


Description | Cautions | Example | Error Codes | See Also

Name:

NCMRetCode NCM_GetCspCountryName( szCountryCode, ppncmName )

Inputs:

char *szCountryCode
  • country code
NCMValue **ppncmName
  • address of pointer where country name will be output

Returns:

NCM_SUCCESS if success NCM error code if failure

Includes:

NCMApi.h

Mode:

synchronous

Description

The NCM_GetCspCountryName( ) function gets the country name for a country code from the DCM Catalog. 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
ppncmName address of the pointer that will point to the country name

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

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


PREV TOC HOME INDEX NEXT

Click here to contact Telecom Support Resources

Copyright 2003, Intel Corporation
All rights reserved
This page generated January, 2003