IRTCSessionCallControl::Hold
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method places an existing session on hold. The method is intended for voice and video sessions only. The media stream associated with the call will be freed for use by another call.
Syntax
HRESULT Hold(
LONG_PTR lCookie
);
Parameters
lCookie
[in] Pointer to an application-specified cookie that can be used for pairing notifications with the information sent.The application should guarantee a unique value for this cookie.
Return Value
This method can return an RTC_E_ constant.
The following table shows an additional return value and additional information about specific return values.
| Value | Meaning |
|---|---|
E_OUTOFMEMORY |
Insufficient memory to perform this operation. |
RTC_E_INVALID_SESSION_STATE |
The session is not in the connected state. |
RTC_E_MEDIA_DISABLED |
The media has been disabled. |
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.2 and later |