NCM_Dealloc( )

---

Description | Cautions | Example

Name:	NCMRetCode NCM_Dealloc( pncmString )
Inputs:	NCMString* pncmString	pointer to an NCMString
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_Dealloc( ) function deallocates memory allocated for DCM API structures. For more information about memory allocation, see Section 2.4, Dynamic Memory Allocation.

The function parameter is defined as follows:

Parameter	Description
pncmString	pointer to the structure occupying the memory to be freed; if the structure is the first in a linked list, this function deallocates the memory occupied by all structures in the list

Cautions

None

Example

#include "NCMApi.h" 
... 
NCMFamily * pFamilies = NULL; 
// get family list
NCMRetCode ncmRc = NCM_GetAllFamilies( &pFamilies ); 
if ( ncmRc == NCM_SUCCESS ) 
{
     ...
}
else 
{     // Process error
     ...
} 
//
// Execute
// 
// Deallocate memory for family list
NCM_Dealloc( pFamilies );
... 

Click here to contact Telecom Support Resources