2.3.1. Populating Required Structures

There are a number of structures that are necessary in order to perform basic DCM API operations. For example, the NCM_SetValue( ) function, which enables you to change the value of a configuration parameter, requires structures to identify the family, device, and property to which the configuration parameter to be modified belongs.

The following steps illustrate how to populate these structures:

1. Use NCM_GetAllFamilies( ) to return a list of NCMFamily structures; the structures in this list indicate the families for all installable devices defined by the current version of the DCM Catalog.
2. Use any one of the NCMFamily structures as input to NCM_GetAllDevices( ) to return a list of NCMDevice structures for one of the families designated by the list of NCMFamily structures. Lists of installable devices can be retrieved only for one family at a time.
3. Use the NCMFamily and NCMDevice structures for a specific device as input to NCM_GetProperties( ); this function returns a list of NCMProperty structures for the device identified by the NCMFamily and NCMDevice structures. Lists of properties can be retrieved only for one device at time.
4. Use the NCMProperty, NCMFamily, and NCMDevice structures as input to NCM_GetVariables( ); this function returns a list of NCMVariable structures for the installable device indicated by the specified input structures. The list of NCMVariable structures contains all the installable configuration parameters within the property for the specified device.

   Note: The contents of the NCMVariable structure list varies depending on the specific device being queried. For example, the System property for a D/41D device contains the D41DAddress, D41DInterrupt, and ISABusWidth parameters, whereas the same property for a D/240SC device contains BLTAddress, BLTInterrupt, BLTId, and ISABusWidth.

For more information about these structures, see Chapter 3, DCM API Structures.

Click here to contact Telecom Support Resources