Dialogic Global Call IP Benutzerhandbuch
430
Dialogic
®
Global Call IP Technology Guide — November 2007
Dialogic Corporation
gc_util_find_parm_ex( ) — find a parameter in a GC_PARM_BLK
gc_util_find_parm_ex( )
find a parameter in a GC_PARM_BLK
Description
The gc_util_find_parm_ex( ) function is used to find a parameter of a particular type in a
GC_PARM_BLK and retrieve the parameter data into a GC_PARM_DATA_EXT structure.
GC_PARM_BLK and retrieve the parameter data into a GC_PARM_DATA_EXT structure.
This function must be used instead of the similar gc_util_find_parm( ) function if the parameter
data can potentially exceed 255 bytes. This function is backward compatible and can be used
instead of gc_util_find_parm( ) for any GC_PARM_BLK, regardless of whether the parameter
block contains setID/parmID pairs that support data lengths greater than 255 bytes.
data can potentially exceed 255 bytes. This function is backward compatible and can be used
instead of gc_util_find_parm( ) for any GC_PARM_BLK, regardless of whether the parameter
block contains setID/parmID pairs that support data lengths greater 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
The gc_util_find_parm_ex( ) function can be used to determine whether a particular parameter
exists, or to retrieve a particular parameter, or both. If the specified parameter is found in the
exists, or to retrieve a particular parameter, or both. If the specified parameter is found in the
Name:
int gc_util_find_parm_ex(parm_blk, setID, parmID, parm)
Inputs:
GC_PARM_BLKP parm_blk
•
pointer to GC_PARM_BLK to search for the parameter
unsigned long setID
•
parameter set ID of parameter to be found
unsigned long parmID
•
parameter ID of parameter to be found
GC_PARM_DATA_EXTP parm
•
pointer to a valid GC_PARM_DATA_EXT structure that
identifies where in the parm block to start searching
identifies where in the parm block to start searching
Outputs:
GC_PARM_DATA_EXTP parm
•
if successful, pointer to a GC_PARM_DATA_EXT
structure that contains the ID and value data for the
specified parameter
structure that contains the ID and value data for the
specified parameter
Returns:
GC_SUCCESS if successful
EGC_NO_MORE_PARMS if no more parameters exist in GC_PARM_BLK
GC_ERROR if failure
EGC_NO_MORE_PARMS if no more parameters exist in GC_PARM_BLK
GC_ERROR if failure
Includes:
gclib.h
gcerr.h
gcerr.h
Category:
GC_PARM_BLK utility
Mode:
synchronous