gc_HoldACK( )

---

Termination Events | Cautions | Errors | Example | See Also

Name:	int gc_HoldACK(crn)
Inputs:	CRN crn	call reference number
Returns:	0 if successful <0 if failure
Includes:	gclib.h gcerr.h
Category:	interface specific
Mode:	synchronous
Platform and Technology:	Springware: ISDN BRI, ISDN PRI (DPNSS and Q.SIG only)

Description

The gc_HoldACK( ) function accepts a hold request from remote equipment. Call this function only when the call is in the Connected state and after the GCEV_HOLDCALL event is received.

Parameter	Description
crn	call reference number

Termination Events

None

Cautions

The call must be in the Connected state and the GCEV_HOLDCALL event detected before this function is invoked or the function will fail.

Errors

If this function returns <0 to indicate failure, use the gc_ErrorInfo( ) function to retrieve the reason for the error. See the "Error Handling" section in the Global Call API Programming Guide. All Global Call error codes are defined in the gcerr.h file. If the error returned is technology specific, see the technology-specific error header file(s) for the error definition (for example, ccerr.h or isdnerr.h file for the ISDN call control library).

Example

/*
 * Assume the following has been done:
 * 1. device has been opened (e.g. :N_dtiB1T1:P_isdn, 
 *    :N_dtiB1T2:P_isdn, etc...)
 * 2. gc_WaitCall() has been issued to wait for a call.
 * 3. gc_GetMetaEvent() or gc_GetMetaEventEx() (Windows) has been 
 *    called to convert the event into metaevent.
 * 4. a GCEV_OFFERED event has been detected.
 */ 
#include <stdio.h>
#include <srllib.h>
#include <gclib.h>
#include <gcerr.h>
#include <gcisdn.h>
METAEVENT metaevent; 
int hold_call() 
{
    LINEDEV  ldev;           /* Line device */
    CRN      crn;            /* call reference number */
    GC_INFO  gc_error_info;  /* GlobalCall error information data */ 
    /*
     * Do the following:
     *    1. Get the CRN from the metaevent
     *    2. Proceed to place the call on hold
     */ 
    crn = metaevent.crn; 
    if(gc_HoldCall(crn, EV_ASYNC) != GC_SUCCESS) {
        gc_ErrorInfo( &gc_error_info );
        printf ("Error: gc_HoldCall() on linedev: 0x%lx, GC ErrorValue: 0x%hx - %s, 
                 CCLibID: %i - %s, CC ErrorValue: 0x%lx - %s\n",
                 metaevent.evtdev, gc_error_info.gcValue, gc_error_info.gcMsg, 
                 gc_error_info.ccLibId, gc_error_info.ccLibName,
                 gc_error_info.ccValue, gc_error_info.ccMsg);
        return (gc_error_info.gcValue);
    } 
    return 0;
}    
/* Retrieve events from SRL */
int evt_hdlr()
{
    LINEDEV   ldev;            /* Line device */
    CRN       crn;             /* Call Reference Number */
    GC_INFO  gc_error_info;  /* GlobalCall error information data */
    int       retcode;         /* Return Code */ 
    retcode = gc_GetMetaEvent(&metaevent);
    if (retcode <0 ) {
           /* get and process the error */
    } else {
           /* Continue with normal processing */
    } 
    crn = metaevent.crn; 
    switch(metaevent.evttype) {
     case GCEV_HOLDCALL:
        /* retrieve signaling information from queue */
        if (gc_HoldACK(crn) != GC_SUCCESS) {
            gc_ErrorInfo( &gc_error_info );
            printf ("Error: gc_HoldACK() on linedev: 0x%lx, GC ErrorValue: 0x%hx - %s, 
                   CCLibID: %i - %s, CC ErrorValue: 0x%lx - %s\n",
                   metaevent.evtdev, gc_error_info.gcValue, gc_error_info.gcMsg, 
                   gc_error_info.ccLibId, gc_error_info.ccLibName,
                   gc_error_info.ccValue, gc_error_info.ccMsg);
        }
        else {
            /* succeeded, process signaling information */
        } 
        break;
    }
    return 0;
 } 

See Also

• gc_HoldCall( )
• gc_RetrieveCall( )

Click here to contact Telecom Support Resources