4. Function Reference

This section provides an alphabetical reference of all DCM API functions. The table of contents for this manual indicates the page number for each function description.

The following limitations and restrictions apply to the functions described in this section:

• The code samples in the Function Reference use C syntax.
• The DCM API function code samples are not compilable.
• The NCM_GetVariables( ) function can be used to retrieve a list of all global configuration parameters from the DCM Catalog by setting both the NCMFamily and NCMDevice structures to NULL.
• All auto-detectable Intel® Dialogic devices in the system must be detected using either the NCM_DetectBoards( ) function or the NCM_DetectBoardsEx( ) function before the NCM_StartDlgSrv( ) function can be used to start the Intel® Dialogic System Service.
• Because devices are instantiated in the system configuration according to their unique device name, it is impossible to correlate an instantiated device with a device model name. Intel® Dialogic strongly recommends that you embed the device model name within the unique device name when you instantiate a device with the NCM_AddDevice( ) function.
• If you use the NCM_SetDlgSrvStartupMode( ) function to set the Intel® Dialogic System Service startup mode to Automatic, the system does not auto-detect devices before starting the Intel® Dialogic System Service. Therefore, the following restrictions apply when the system is rebooted in Automatic mode:
  • You cannot add or remove SpringWare devices.
  • You cannot add or remove DM3 PCI devices. However, you can replace a DM3 PCI device with an identical device. For example, you can physically remove a DM/V960-4T1-PCI from the system, but you must install another DM/V960-4T1-PCI in the same PCI slot as the original board.
  • You can add or remove DM3 CompactPCI (cPCI) devices while the system is powered on. However, you must first use the NCM_StopDlgSrv( ) function to stop the Intel® Dialogic System Service and then use the NCM_DetectBoardsEx( ) function before rebooting the system. Alternatively, you can use the NCM_StopBoard( ) and NCM_StartBoard( ) functions to perform a Hot Swap of the DM3 cPCI device without stopping the Intel® Dialogic System Service or telephony application. Refer to Section 2.9, Single Board Stop/Start (Hot Swap) for more information about Hot Swap.

Note: Do not use any of the functions described in this section without first reading Chapter 2, Using the DCM API.

Click here to contact Telecom Support Resources