Dialogic 05-2239-009 User Manual
436
Dialogic
®
Global Call IP Technology Guide — November 2007
Dialogic Corporation
gc_util_next_parm_ex( ) — retrieve the next parameter in a GC_PARM_BLK
gc_util_next_parm_ex( )
retrieve the next parameter in a GC_PARM_BLK
Description
The gc_util_next_parm_ex( ) function is used to retrieve the next parameter element (relative to a
specified current parameter element) from a GC_PARM_BLK in the form of a
GC_PARM_DATA_EXT data structure. Calling this function repetitively and passing a pointer to
the GC_PARM_DATA_EXT structure that was returned by the previous call allows an application
to sequentially retrieve all of the parameter elements in a GC_PARM_BLK. To begin retrieving
parameter elements at the beginning of the GC_PARM_BLK, the application passes a pointer to a
GC_PARM_DATA_EXT structure that it has just initialized by calling
INIT_GC_PARM_DATA_EXT(parm).
specified current parameter element) from a GC_PARM_BLK in the form of a
GC_PARM_DATA_EXT data structure. Calling this function repetitively and passing a pointer to
the GC_PARM_DATA_EXT structure that was returned by the previous call allows an application
to sequentially retrieve all of the parameter elements in a GC_PARM_BLK. To begin retrieving
parameter elements at the beginning of the GC_PARM_BLK, the application passes a pointer to a
GC_PARM_DATA_EXT structure that it has just initialized by calling
INIT_GC_PARM_DATA_EXT(parm).
This function must be used instead of gc_util_next_parm( ) if the parameter value can potentially
exceed 255 bytes. This function is backward compatible and can be used instead of
gc_util_next_parm( ) for any GC_PARM_BLK, regardless of whether the parameter block
contains setID/parmID pairs that support values longer than 255 bytes.
exceed 255 bytes. This function is backward compatible and can be used instead of
gc_util_next_parm( ) for any GC_PARM_BLK, regardless of whether the parameter block
contains setID/parmID pairs that support 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:
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
Name:
int gc_util_next_parm_ex(parm_blk, parm )
Inputs:
GC_PARM_BLKP parm_blk
•
pointer to GC_PARM_BLK
GC_PARM_DATA_EXTP parm
•
pointer to valid GC_PARM_DATA_EXT structure
identifying current parameter
identifying current parameter
Outputs:
GC_PARM_DATA_EXTP parm
•
pointer to GC_PARM_DATA_EXT structure
containing retrieved next parameter
containing retrieved next parameter
Returns:
GC_SUCCESS if successful
EGC_NO_MORE_PARMS if no more parameters exist in the GC_PARM_BLK
GC_ERROR if failure
EGC_NO_MORE_PARMS if no more parameters exist in the GC_PARM_BLK
GC_ERROR if failure
Includes:
gclib.h
gcerr.h
gcerr.h
Category:
GC_PARM_BLK utility
Mode:
synchronous