NCM_GetAllFamilies( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_GetAllFamilies( ppncmFamily )
Inputs:	NCMFamily **ppncmFamily	address of a pointer in which the list of device families will be output
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_GetAllFamilies( ) function gets a list of installable families. For information about using this function to fill all the structures you need to instantiate and modify configuration parameter values, see Section 2.3.1, Populating Required Structures.

The function parameter is defined as follows:

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

Cautions

The information provided by this function is limited to the DCM Catalog. To retrieve information that is instantiated in your system configuration, use NCM_GetInstalledFamilies( ). 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_GetAllFamilies( &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_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_INVALID_INPUTS	the values of the parameters supplied are invalid

See Also

• NCM_GetAllDevices( )
• NCM_Dealloc( )
• NCM_DeallocValue( )
• NCM_GetProperties( )
• NCM_GetValueRange( )
• NCM_GetValueRangeEx( )
• NCM_GetVariables( )

Click here to contact Telecom Support Resources