NCM_StopBoard( )

---

Description | Cautions | Example | Error Codes | See Also

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

Description

The NCM_StopBoard( ) function stops a single Intel® Dialogic DM3 board. This function only applies to DM3 PCI (H.100) and CompactPCI (H.110) boards. The function blocks until the board is completely stopped. For more information about stopping a single Intel® Dialogic DM3 Board, see Section 2.9, Single Board Stop/Start (Hot Swap).

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

Cautions

This function is applicable only to devices that are capable of being started and stopped on an individual basis (i.e., DM3 PCI and CompactPCI boards).

Example

#include "NCMApi.h"
... 
//
// Prepare inputs
// 
NCMFamily family;
Family.name = "DM3";
Family.next = NULL; 
NCMDevice device;
device.name = "QS_T1-1";
device.next = NULL; 
//
// Execute
//
NCMRetCode        ncmRc = NCM_StopBoard(&family, &device); 
if ( ncmRc != NCM_SUCCESS )
{        // process error code
        ...
} 

Error Codes

Equate	Returned When
NCME_GENERAL	a problem occurred retrieving the data

See Also

• NCM_StartBoard( )

Click here to contact Telecom Support Resources