2.3.4. Device Model Names and Unique Device Names

The NCMDevice structure can be set to a "device model name" or a "unique device name". A device model name is the generic Intel® Dialogic name for a device, such as "D/41D" and "D/240SC". The device model name is necessary to retrieve a list of installable devices with the NCM_GetAllDevices( ) function.

A unique device name is a unique identifier that you create when you instantiate a device in the system configuration using the NCM_AddDevice( ) function. The unique device name is necessary to distinguish multiple instances of the same device model in the system.

DCM API functions that take a pointer to an NCMDevice structure as input differ with respect to the type of device name they require. These functions fall into the following categories:

• Functions that write to or read from the system configuration and require a unique device name. This category includes:
  • NCM_AddDevice( )
  • NCM_DeleteEntry( )
  • NCM_EnableBoard( )
  • NCM_IsBoardEnabled( )
  • NCM_SetValue( )
  • NCM_SetValueEx( )
  • NCM_StartBoard( )
  • NCM_StopBoard( )

    You create the unique device name with the NCM_AddDevice( ) function. You can then retrieve the unique device name with the NCM_GetInstalledDevices( ) function. The unique device name you retrieve can then be used with the other functions in this category.

  Note: 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.

• Functions that read from the DCM Catalog and require either a device model name or a unique device name. This category includes:
  • NCM_GetProperties( )
  • NCM_GetValueRange( )
  • NCM_GetValueRangeEx( )
  • NCM_GetVariables( )
  • NCM_IsEditable( )

The data provided by the NCM_GetValue( ) and NCM_GetValueEx( ) functions is affected by whether NCMDevice is a device model name or a unique device name. If NCMDevice is a device model name, these functions read the default configuration parameter value from the DCM Catalog. If NCMDevice is a unique device name, they read the instantiated configuration parameter value from the system configuration.

In the DCM API functions in Chapter 4, Function Reference, the entries for functions that require an NCMDevice structure as input indicate whether the structure must contain a device model name or a unique device name.

Click here to contact Telecom Support Resources