Dialogic 05-2239-009 User Manual

Page of 604
558
Dialogic
®
 Global Call API Library Reference — November 2007
Dialogic Corporation
IPCCLIB_START_DATA — IP call control library configuration information
IPCCLIB_START_DATA
IP call control library configuration information
typedef struct
{
    unsigned short    version;
    unsigned char     delimiter;
    unsigned char     num_boards;
    IP_VIRTBOARD      *board_list;
    unsigned long     max_parm_data_size;
    unsigned short    media_operational_mode; 
} IPCCLIB_START_DATA;
„ Description
The IPCCLIB_START_DATA structure is used to configure the IP call control library when 
starting Dialogic
®
 Global Call API. The IPCCLIB_START_DATA structure is passed to the 
gc_Start( ) function via the CCLIB_START_STRUCT and GC_START_STRUCT data structures. 
Applications must use the 
 function to populate a 
IPCCLIB_START_DATA structure with default values before overriding the default values as 
desired.
„ Field Descriptions
The fields of the IPCCLIB_START_DATA data structure are described as follows:
version 
The version of the start structure. The correct version number is populated by the 
INIT_IPCCLIB_START_DATA( ) function and should not be used by applications. 
delimiter 
An ANSI character that specifies the address string delimiter; the default delimiter is the 
comma ( , ). The specified delimiter character is used to separate the components of the 
destination information when using gc_MakeCall( ), for example.
num_boards 
The number of IPT virtual board devices to create. See 
page 47 for more information on IPT board devices. The maximum value is 8, and the default 
value is 2.
board_list 
A pointer to an array of IP_VIRTBOARD structures, one structure for each of num_boards 
IPT board devices. See 
, on page 553 for more information.
max_parm_data_size (structure version 
≥ 0x200)
The maximum data size (in bytes) for Global Call parameters that support values longer than 
255 bytes. The default value for this field is 255 for backwards compatibility; the maximum 
value is 4096. 
Only specific Global Call parameters support >255 byte values. These parameters include:
IPSET_MIME or IPSET_MIME_200OK_TO_BYE / IPPARM_MIME_PART_HEADER 
IPSET_MIME or IPSET_MIME_200OK_TO_BYE / IPPARM_MIME_PART_TYPE
IPSET_NONSTANDARDCONTROL / IPPARM_NONSTANDARDDATA_DATA
IPSET_NONSTANDARDDATA / IPPARM_NONSTANDARDDATA_DATA
IPSET_SDP / all four parameter IDs (supported in 3PCC operating mode only)
IPSET_SIP_MSGINFO / IPPARM_SIP_HDR