NCM_EnableBoard( )

---

Description | Cautions | Example | Error Codes | See Also

Name:	NCMRetCode NCM_EnableBoard( pncmFamily, pncmDeviceUnique, bEnable )
Inputs:	NCMFamily *pncmFamily	pointer to a structure containing a device family name
	NCMDevice *pncmDeviceUnique	pointer to a structure containing a unique device name
	BOOL bEnable	Boolean indicator of enable or disable option
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_EnableBoard( ) function enables or disables device initialization when the Intel® Dialogic System Service is run. For more information about device initialization, see Section 2.8, Starting and Stopping the Intel® Dialogic System Service.

The effect of this function depends on how you set the bEnable parameter:

• To allow device initialization: Set bEnable to TRUE.
• To prevent device initialization: Set bEnable to FALSE.

This function's scope depends upon what values are passed for the NCMFamily and NCMDevice pointers:

• To affect initilization for a device: pncmFamily and pncmDeviceUnique should point to an instantiated device.
• To affect initilization for a family: pncmFamily should point to a valid family and pncmDeviceUnique should be NULL.
• To affect initilization for all devices: pncmFamily and pncmDeviceUnique should both be NULL.

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
bEnable	Boolean variable specifying that devices should be enabled (TRUE) or disabled (FALSE)

Cautions

This function only affects devices instantiated in the current system configuration. It has no effect on the installable families, devices, and configuration parameters defined in the DCM Catalog.

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; 
//
// Execute
// 
// Enable a single device
NCMRetCode ncmRc = NCM_EnableBoard( &family, &device, TRUE ); 
if ( ncmRc == NCM_SUCCESS )
{
     ...
}
else
{     // Process error
     ...
} 
// Enable a family of devices
ncmRc = NCM_EnableBoard( &family, NULL, TRUE ); 
if ( ncmRc == NCM_SUCCESS )
{
     ...
}
else
{     // Process error
     ...
} 
// Disable all devices
ncmRc = NCM_EnableBoard( NULL, NULL, FALSE ); 
if ( ncmRc == NCM_SUCCESS )
{
     ...
}
else
{     // Process error
     ...
} 
... 

Error Codes

Equate	Returned When
NCME_GENERAL	a problem occurred retrieving the data
NCME_INVALID_INPUTS	the values of the parameters supplied are invalid
NCME_SP	invalid state transition
NCME_BAD_DATA_LOC	the data destination is invalid or indeterminate
NCME_DATA_NOT_FOUND	requested data not found in NCM data storage

See Also

• NCM_IsBoardEnabled( )

Click here to contact Telecom Support Resources