NCM_IsBoardEnabled( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_IsBoardEnabled( pncmFamily, pncmDeviceUnique, pbEnabled )
Inputs:	NCMFamily *pncmFamily	pointer to a structure containing a device family name
	NCMDevice *pncmDeviceUnique	pointer to a structure containing unique device name
	BOOL *pbEnabled	pointer to a Boolean
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_IsBoardEnabled( ) function determines if a device is to be initialized.

This function queries the system configuration to determine if a device is enabled to be initialized. If so, the address referenced by the pbEnabled pointer is set to TRUE; otherwise it is set to FALSE. For more information about device initialization, see Section 2.8, Starting and Stopping the Intel® Dialogic System Service.

The function parameters are defined as follows:

Parameter	Description
pncmFamily	pointer to the structure containing the family name; the value contained in the structure must be an instantiated family (see Cautions below)
pncmDeviceUnique	pointer to the structure containing the device's unique name; the unique device name must be the same name you used to add the device to the system configuration with the NCM_AddDevice( ) function
pbEnabled	pointer to a Boolean variable indicating that device is to be initialized (TRUE) or is not to be initialized (FALSE)

Cautions

This function queries devices that are instantiated in the current system configuration. It has no effect on the installable families, devices and configuration parameters defined in the DCM Catalog. For more information about the distinction between the system configuration and the DCM Catalog, see Section 2.1, The DCM API Architecture.

Example

#include "NCMApi.h" 
...
//
// Prepare inputs
// 
NCMFamily family;
family.name = "D/x1D";
family.next = NULL; 
NCMDevice device;
device.name = "D/41D-1";
device.next = NULL; 
BOOL     bEnabled = TRUE; 
//
// Execute
// 
NCMRetCode     ncmRc = NCM_IsBoardEnabled( &family, &device, &bEnabled ); 
if ( ncmRc == NCM_SUCCESS )
{
     if ( bEnabled == TRUE )
     {
          ...
     }
     else
     {
          ...
     }
}
else
{     // Process error
     ...
}
... 

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
NCME_DATA_NOT_FOUND	requested data not found in NCM data storage

See Also

• NCM_EnableBoard( )

Click here to contact Telecom Support Resources