Dialogic® Global Call API Library Reference

gc_SetConfigData( ) — update the configuration data
Parameter Description
target_type target object type
target_id target object identifier. This identifier, along with target_type, uniquely
specifies the target object.
target_datap points to the GC_PARM_BLK structure. This structure contains the
parameter configuration data to be updated. See GC_PARM_BLK, on
page 443 for more information.
time_out time interval (in seconds) during which the target object must be updated
with the data; if the interval is exceeded, the request to update is ignored.
This parameter is ignored when set to 0.
This parameter is supported in synchronous mode only. If the update
request is not completed in the time specified, the gc_SetConfigData( )
function will return EGC_TIMEOUT.
update_cond specifies when to update. Valid values are:
GCUPDATE_IMMEDIATE – requires parameter to be updated
immediately
GCUPDATE_ATNULL – requires parameter to be updated at the Null
call state. Applicable only if the target_type is associated with a call.
Note: The GCUPDATE_ATNULL value should be used only if the
gc_SetConfigData( ) function is called in asynchronous mode, that is,
with the mode parameter set to EV_ASYNC.
request_idp points to the location for storing the request ID, which is generated by
Global Call
mode set to EV_ASYNC for asynchronous execution or to EV_SYNC for
synchronous execution
The parameter target_datap points to the location of the GC_PARM_BLK, which stores the
configuration parameter data to be updated. Memory allocation and deallocation of the
GC_PARM_BLK data block is done by the Global Call utility functions (gc_util_xxx). See
Section 1.15, “GC_PARM_BLK Utility Functions”, on page 25 for more information.
It is the Global Call application’s responsibility to use the Global Call utility functions to allocate
an appropriate-size data block memory (GC_PARM_BLK) for the configuration parameters and to
insert parameter information (such as the set ID, parm ID, value buffer size, value buffer, and value
data) into the GC_PARM_BLK data block. After successfully calling the gc_SetConfigData( )
function, the parameter value(s) in the GCLib or CCLib are updated with the values given in the
GC_PARM_BLK (value buffer fields). After finishing its use of the GC_PARM_BLK, the Global
Call application should deallocate the GC_PARM_BLK data block using the
gc_util_delete_parm_blk( ) function. See GC_PARM_BLK, on page 443 for more information.
The function outputs a unique request ID to verify received update events and query the update
results. All subsequent references to this request must be made using the request ID.
The parameter configuration data can be either read-only, update immediately, or update at the Null
call state. When the gc_SetConfigData( ) function is issued, the action taken by the application
depends on the update condition of the parameter, as described in Table 14.
320 Dialogic ® Global Call API Library Reference — January 2008
Dialogic Corporation