3.1. Data Structures

The NCMString structure defines most structures in the DCM API.

typedef struct NCMString
{
     char              *name;
     struct NCMString  *next;
} NCMString; 

The following structures are aliases for NCMString:

• NCMFamily
• NCMDevice
• NCMProperty
• NCMValue
• NCMVariable
• NCMErrorMsg

The NCMPropertyAttributes is defined as follows:

typedef enum
{
     NCM_PROPERTY_UNDEFINED = -1,
     NCM_PROPERTY_VISIBLE,
     NCM_PROPERTY_HIDDEN
} NCMPropertyAttributes; 

The NCMVariableAttributes structure is defined as follows:

typedef struct _NCMVariableAttributes
{
     unsigned int             structsize;
     NCMDataType              dataType;
     int                      radix;
     NCMVariableDomainType    domainType;
     NCMVariableVisibleType   visibleType;
     NCMVariableEditType	      editType;
} NCMVariableAttributes; 

The NCMSysVersion structure is defined as follows:

typedef struct _NCMSysVersion 
{
     char szOSName[MAX_PATH];         // Name of operating system (Windows ...)
     char szOSVersion[MAX_PATH];      //Version of OS
     char szOSBuild[MAX_PATH];        //OS build number
     char szOSType[MAX_PATH];         //OS Type 
     char szOSSvcPack[MAX_PATH];      // OS Service Pack number
     char szDSSVersion[MAX_PATH];     //Dialogic software version 
     char szDSSRelease[MAX_PATH];     // Dialogic software release
     char szDSSBuild[MAX_PATH];       //Dialogic software build number
     char szDSSSvcPack[MAX_PATH];     //Dialogic software Service Pack number
} NCMSysVersion; 

The NCM_TS_BLOCK_STRUCT data structure is defined as follows:

typedef _TS_BLOCK_STRUCT
{
   int   version;
   int   start_time_slot; //starting time slot number of the reserved block
   int   number_of_time_slots; //total number of time slots in the reserved block
} NCM_TS_BLOCK_STRUCT 

The NCM_TDM_BUS_CAPS data structure is defined as follows:

typedef struct
{
   int    structVersion;
   bool   bH100MasterCapable;
   bool   bH100SlaveCapable;
   bool   bH110MasterCapable;
   bool   bH110SlaveCapable;
   bool   bScbusMasterCapable;
   bool   bScbusSlaveCapable;
   bool   bMvipMasterCapable;
   bool   bMvipSlaveCapable;
   bool   bScbus2MhzCapable;
   bool   bScbus4MhzCapable;
   bool   bScbus8MhzCapable;
} NCM_TDM_BUSCAPS;
 

For instructions on using these structures, see Section 2.3.1, Populating Required Structures.

Click here to contact Telecom Support Resources