NCM_GetInstalledFamilies( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_GetInstalledFamilies (ppncmFamily )
Inputs:	NCMFamily **ppncmFamily	address of pointer where the instantiated board families will be output
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_GetInstalledFamilies( ) function gets all instantiated device families.

This function fills a pointer to a pointer with the beginning address of a list of instantiated device families.

The function parameter is defined as follows:

Parameter	Description
ppncmFamily	address of the pointer to the list to be filled with family structures

Cautions

This function enables you to determine what families are instantiated in the system configuration. To find out what families are available in the DCM Catalog, use the NCM_GetAllFamilies( ) function. For more information about the distinction between the system configuration and the DCM Catalog, see Section 2.1, The DCM API Architecture.

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

Error Codes

Equate	Returned When
NCME_INVALID_INPUTS	the values of the parameters supplied are invalid

See Also

• NCM_GetInstalledDevices( )
• NCM_GetValue( )
• NCM_GetValueEx( )
• NCM_SetValue( )
• NCM_SetValueEx( )
• NCM_Dealloc( )
• NCM_DeallocValue( )

Click here to contact Telecom Support Resources