Share via

IRTCSessionCallControl::Hold

The Hold method places an existing session on hold. This method is intended only for voice or video sessions. The media stream associated with the call will be freed for use by another call.

HRESULT Hold(LONG_PTRlCookie);

Parameters

  • lCookie
    [in] An application-provided cookie, which can be used for pairing the notifications with the information sent. The application should guarantee a unique value for this cookie.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
RTC_E_INVALID_SESSION_STATE The session is not in the connected state.
RTC_E_MEDIA_DISABLED The media has been disabled.
E_OUTOFMEMORY Insufficient memory to perform this operation.

Requirements

Redistributable: Requires Rtcdll.dll on Windows 2000, Windows XP, and Windows Server 2003.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCSessionCallControl is defined as E9A50D94-190B-4F82-9530-3B8EBF60758A.

See Also

IRTCSessionCallControl, Session Control, Session Hold and Unhold