IVoIPMediaMgr::HoldSession

This method places a session on hold. If the RTC API is handling media, this method calls IRTCSessionCallControl::Hold. If RTC is not handling the media, HoldSession calls IRTCSession2::ReInviteWithSessionDescription.

HRESULT HoldSession( 
  IRTCSession2* piSession
);

Parameters

  • piSession
    [in] Pointer to an IRTCSession2 interface to be placed on hold. Because this method is called from the VoIP manager, a session with state RTCSS_CONNECTED is assumed.

Return Values

If the HRESULT value passed to SUCCEEDED macro returns TRUE, the method succeeded. Otherwise, the method failed.

Requirements

OS Versions: Windows CE .NET 4.2 and later.
Header: Voipmediamanager.idl.
Link Library: Voipguid.lib.

See Also

VoIP Application Interface Layer Architecture | VoIP Application Interface Layer Reference | IRTCSession2 | IRTCSession2::ReInviteWithSessionDescription | IRTCSessionCallControl::Hold | IVoIPMgr

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.