2.1 Function Syntax Conventions

The Global Call API functions use the following format:
int gc_function(reference, param1, param2, ..., paramN, mode)
where:

int

represents an integer return value that indicates if the function succeeded or failed. Possible values are:

• 0 if the function succeeds
• <0 if the function fails

gc_function

represents the function name

reference

represents an input field that directs the function to a specific line device or call. Possible data types for this parameter are:

• LINEDEV for a line device
• CRN for a call

param1

represents the first parameter

paramN

represents the last parameter

mode

indicates the mode of execution. Possible values are:

• EV_ASYNC for asynchronous mode execution
• EV_SYNC for synchronous mode execution

Note: In the C language coding example listed in the Example section for each function, the symbolic constant GC_SUCCESS is used as the function return value. GC_SUCCESS is defined in the gcerr.h header file to equate to 0.

Click here to contact Telecom Support Resources