ITBasicCallControl::Hold method (tapi3if.h)

The Hold method places or removes the call from the hold.

Syntax

HRESULT Hold(
  VARIANT_BOOL fHold
);

Parameters

fHold

If fHold is VARIANT_TRUE and the method succeeds, the call state transitions to the CS_HOLD state. If fHold is VARIANT_FALSE, the call state transitions to CS_CONNECTED.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.
TAPI_E_INVALCALLSTATE
The call associated with this interface no longer exists.
TAPI_E_TIMEOUT
The operation failed because the TAPI 3 DLL timed it out. The timeout interval is two minutes

Remarks

Some service providers do not support this operation while streaming is active. The application may need to call ITStream::StopStream or ITSubStream::StopSubStream prior to the operation and ITStream::StartStream or ITSubStream::StartSubStream following completion of the operation.

Requirements

   
Target Platform Windows
Header tapi3if.h (include Tapi3.h)
Library Uuid.lib
DLL Tapi3.dll

See also

Call Object

Hold overview

ITBasicCallControl

lineHold