Dialogic Dialogic Global Call IP IP Phone User Manual


 
Dialogic
®
Global Call IP Technology Guide — November 2007 433
Dialogic Corporation
insert a GC_PARM_BLK parameter by reference — gc_util_insert_parm_ref_ex( )
gc_util_insert_parm_ref_ex( )
insert a GC_PARM_BLK parameter by reference
Description
The gc_util_insert_parm_ref_ex( ) function inserts a parameter element into a GC_PARM_BLK
data structure using a reference to the parameter value data.
The gc_util_insert_parm_ref_ex( ) function must be used rather than the similar
gc_util_insert_parm_ref(
) function whenever the parameter value data exceeds 255 bytes in
length. The gc_util_insert_parm_ref_ex(
) function is backwards compatible and can be used
with any setID/parmID pair regardless of whether that pair supports values longer than 255 bytes.
Only specific Global Call parameters support values longer than 255 bytes and therefore require
the use of this function. 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
A new GC_PARM_BLK can be created by inserting the first parameter with *parm_blkpp set to
NULL. A parameter can be inserted in an existing GC_PARM_BLK by setting
*parm_blkpp to
the address of that block.
Note: Parameters are contained in the GC_PARM_BLK in the order in which they are inserted, and they
will also be retrieved via the
gc_util_next_parm_ex( ) function in the same order.
Name: int gc_util_insert_parm_ref_ex(parm_blkpp, setID, parmID, data_size, datap)
Inputs: GC_PARM_BLKP *parm_blkpp pointer to the address of a valid GC_PARM_BLK
unsigned long setID set ID of parameter to be inserted
unsigned long parmID parm ID of parameter to be inserted
unsigned long data_size size in bytes of the parameter data
void *datap pointer to the parameter data
Returns: GC_SUCCESS if successful
GC_ERROR if failure
Includes: gclib.h
gcerr.h
Category: GC_PARM_BLK utility
Mode: synchronous