Dialogic 05-0867-005 Table Top Game User Manual


 
cc_RetrieveRej( ) reject a request to retrieve a held call
210
Name:
int cc_RetrieveRej(crn, cause)
Inputs:
CRN crn
call reference number
int cause
standard ISDN Network cause/error
code
Returns:
0 on success
<0 on failure
Includes:
cclib.h
Category:
Hold and Retrieve
Mode:
synchronous
Technology:
BRI/2; BRI/SC; PRI (Q.SIG only)
!
! !
!
Description
The cc_RetrieveRej( ) function allows the application to reject a request to
retrieve a held call from remote equipment. The call must be in Hold state and the
CCEV_RETRIEVECALL event must be received before this function is called.
Parameter Description
crn:
The call reference number. Each call needs a CRN.
cause:
A standard ISDN Network cause/error code is returned
indicating the reason the hold request was rejected. Possible
causes include TEMPORARY_FAILURE (Cause 41),
NETWORK_OUT_OF_ORDER (Cause 38), and
NETWORK_CONGESTION (Cause 42). For a complete list
of ISDN Network cause/error codes, see Section
7.2.2. Cause/Error Codes from the ISDN Network.
!
! !
!
Cautions
The cc_RetrieveRej( ) function can only be used after the call is in Hold
state and after the CCEV_RETRIEVECALL event is received.
The BRI protocols and the PRI Q.SIG protocol are the only protocols that
allow the rejection of the retrieval of a call in the Hold state. The
cc_RetrieveRej( ) function cannot be used in the PRI DPNSS protocol. If
used in unsupported protocols, the cc_RetrieveRej( ) function call will pass
but the retrieve from Hold request will not be rejected and the call will no
longer be in the Hold state.