IRTCSession::RemoveParticipant
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 removes a participant from the session. It is applicable only for outgoing phone-to-phone calls.
Note
: Phone-to-phone calls are, currently, not supported. This method will fail for all other types of calls.
Syntax
HRESULT RemoveParticipant(
IRTCParticipant* pParticipant
);
Parameters
- pParticipant
[in] Pointer to an IRTCParticipant interface on the Participant object to remove from the session.
Return Value
This method can return an RTC_E_ constant.
The following table shows an additional possible return value.
| Value | Description |
|---|---|
E_FAIL |
The participant cannot be removed from this session. |
Remarks
Removing the last participant in the session terminates the session. Calling the IRTCParticipant::Removable method on the participant allows the UI to determine if it is possible to remove this participant from the session.
.gif "Aa921939.security(en-us,MSDN.10).gif") Security Note: |
|---|
| This method can send data over the network in unencrypted form. Therefore, someone eavesdropping on the network might be able to read the data. Before using this method in an unencrypted session, consider the security risk of sending the data in clear text. The application can encrypt an RTC session by specifying TLS in the profile used for the session. |
Requirements
| Header | rtccore.h, rtccore.idl |
| Library | uuid.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |
See Also
Reference
IRTCSession
IRTCParticipant::Removable
IRTCSession::AddParticipant