(Page 10 of 23 in this chapter) Version

nccHoldCall

Description

Puts a call on hold.

Prototype

DWORD nccHoldCall ( NCC_CALLHD callhd,
void *holdparms )
callhd Call handle of the call to put on hold.
holdparms Pointer to protocol-specific CT Access call hold parameter structure. Specify NULL to use default values. See protocol-specific documentation for details.

Return Values

SUCCESS
CTAERR_INVALID_HANDLE
The call handle is not valid. It may have been released.
CTAERR_INVALID_STATE
Line is not in the appropriate state to invoke this function.
NCCERR_INVALID_CALL_STATE
Current state of call handle is not in Connected call state, and the protocol only supports calls being put on hold in the Connected state. The application can determine whether or not a call can be put on hold from any state by examining the NCC_CAP_HOLD_IN_ANY_STATE bit in the capabilitymask returned by nccQueryCapability.
NCCERR_NOT_CAPABLE
Protocol does not support the capability to put a call on hold. The application can determine if the protocol supports this feature by examining the NCC_CAP_HOLD_CALL bit in the capabilitymask returned by nccQueryCapability.

Events

NCCEVN_CALL_HELD
The call hold attempt completed successfully and the call is now on hold. The line state is now Idle.
NCCEVN_HOLD_REJECTED
The request to put a call on hold was rejected. The value field contains information as to why the request was rejected.

If the NCC_CAP_HOLD_IN_ANY_STATE bit is set in the capabilitymask returned by nccQueryCapability, depending upon what state the call is in, you may receive other events that are valid in that state. Refer to the event/call state chart in Section 2.6.4 for details.

Details

This function puts a call on hold. There is no call state transition. However, a call on hold is no longer Active. Since there are no Active calls currently on the line, the line state changes to Idle.
The call is on hold only after the application receives an NCCEVN_CALL_HELD event. The held field in the NCC_CALL_STATUS structure is set to a non-zero value.
Use nccRetrieveCall to unhold a call.
Some protocols do not support the capability to put a call on hold. The application can determine if the protocol supports call hold/retrieve by examining the NCC_CAP_HOLD_CALL bit in the capabilitymask returned by nccQueryCapability.
Some protocols allow a call to be put on hold only from the Connected state. The application can determine whether or not a call can be put on hold from any state by examining the NCC_CAP_HOLD_IN_ANY_STATE bit in the capabilitymask returned by nccQueryCapability.
The application may perform media functions on a held call (i.e., play user voice file, or play silence) using a CT Access media service.

See Also

nccRetrieveCall, nccTransferCall

(Page 10 of 23 in this chapter) Version

tech_support@nmss.com

Copyright © 1999, Natural MicroSystems, Inc. All rights reserved.