Dialogic® Global Call API Library Reference

GC_PARM_DATA_EXT
retrieved parameter data
typedef struct
{
unsigned long version;
void* pInternal;
unsigned long set_ID;
unsigned long parm_ID;
unsigned long data_size;
void* pData;
}GC_PARM_DATA_EXT, *GC_PARM_DATA_EXTP;
Description
retrieved parameter data — GC_PARM_DATA_EXT
The GC_PARM_DATA_EXT structure contains parameter data retrieved from a GC_PARM_BLK
by the gc_util_find_parm_ex( ) and gc_util_next_parm_ex( ) functions. These functions were
added to the Dialogic ® Global Call API library to support the retrieval of parameters whose values
may exceed 255 bytes in length. The functions always return the retrieved parameter information in
a GC_PARM_DATA_EX structure regardless of whether the parameter value actually exceeds 255
bytes.
The set ID and parm ID as a pair identify the parameter. Set IDs and parm IDs that are common to
multiple Global Call technologies are listed in the Dialogic® Global Call API Library Reference,
and additional technology-specific parameters are listed in each of the various Global Call
Technology Guides. Unless a particular set ID/parm IP pair specifically indicates that it supports
parameter data that exceeds 255 bytes in length, users should assume that the parameter data length
does not exceed 255.
The parameters that currently support extended-length values 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
IPSET_TUNNELEDSIGNALMSG / IPPARM_TUNNELEDSIGNALMSG_DATA
Applications must use the INIT_GC_PARM_DATA_EXT( ) function to initialize the structure
with the correct version number and default field values before using the structure in a call to
gc_util_find_parm_ex( ) or gc_util_next_parm_ex( ). Passing a pointer to an uninitialized
structure in the function call may cause an operational error.
Field Descriptions
The fields of GC_PARM_DATA_EXT are described as follows:
version
identifies the version of the data structure implementation. This field is reserved for library use
and should not be modified by applications.
Dialogic ® Global Call API Library Reference — January 2008 445
Dialogic Corporation