IRTCSession::RemoveParticipant

The RemoveParticipant method removes a participant from the session. This is applicable only for outgoing phone-phone calls and will fail for all other types of calls. Removing the last participant in the session will terminate the session. Calling the get_Removable property on the participant will allow the UI to determine if it is possible to remove this participant from the session.

HRESULT RemoveParticipant(IRTCParticipant*pParticipant);

Parameters

  • pParticipant
    [in] Pointer to an IRTCParticipant interface on the Participant object to be removed from the session.

Return Values

RTC methods may return an RTC_E_ constant.

Value Meaning
E_FAIL The participant cannot be removed from this session.

Remarks

This function may send data over the wire in unencrypted form; therefore, someone eavesdropping on the network may be able to read the data. The security risk of sending the data in clear text should be considered before using this method in an unencrypted session. An RTC session can be encrypted by specifying TLS in the profile used for the session.

Requirements

Client: Requires Windows XP.
Server: Requires Windows Server 2003.
Redistributable: Requires Rtcdll.dll on Windows 2000, and Windows Me/98.
Header: Declared in Rtccore.h.
Library: Included as a resource in Rtcdll.dll.
GUID: IID_IRTCSession is defined as 387c8086-99be-42fb-9973-7c0fc0ca9fa8.

See Also

IRTCSession, IRTCParticipant, IRTCSession::AddParticipant