cc_HoldCall( ) place an active call on hold
164
Name: int cc_HoldCall(crn, mode)
Inputs: CRN crn • call reference number
unsigned long mode • synchronous or asynchronous
Returns: 0 on success
<0 on failure
Includes: cclib.h
Category: Hold and Retrieve
Mode: synchronous or asynchronous
Technology: BRI/2; BRI/SC; PRI (DPNSS and Q.SIG only)
!
! !
!
Description
The cc_HoldCall( ) function allows the application to place an active call on
hold. For PRI protocols and for BRI Network-side, the call must be in the
Connected state to be put on hold. For BRI User-side, the call can be put on hold
any time after the CCEV_PROCEEDING message is received.
Parameter Description
crn: The call reference number. Each call needs a CRN.
mode: Specifies synchronous (EV_SYNC) or asynchronous
(EV_ASYNC) mode.
!
! !
!
Termination Events
• CCEV_HOLDACK - indicates that the call has been placed on hold.
• CCEV_HOLDREJ - indicates that the hold request was rejected by the
firmware or remote equipment.
In synchronous mode, the CCEV_TASKFAIL event is returned if the function
fails.
!
! !
!
Cautions
For PRI protocols and BRI Network-side, the cc_HoldCall( ) function is valid
only when the call is in the Connected state. For BRI User-side, the function can
be called any time after the CCEV_PROCEEDING message is received.