Ejects all endpoints of a participant from the conference.

Namespace:  Microsoft.Rtc.Collaboration
Assembly:  Microsoft.Rtc.Collaboration(in Microsoft.Rtc.Collaboration.dll)

Syntax

Visual Basic (Declaration)
Public 
Function 
BeginEject ( _
	
participant 
As 

ConversationParticipant, _
	
userCallback 
As 
AsyncCallback, _
	
state 
As 
Object _
) 
As 
IAsyncResult
C#
public 
IAsyncResult 
BeginEject(
	

ConversationParticipant 
participant,
	
AsyncCallback 
userCallback,
	
Object 
state
)
Visual C++
public:
IAsyncResult^ 
BeginEject(
	

ConversationParticipant^ 
participant, 
	
AsyncCallback^ 
userCallback, 
	
Object^ 
state
)
JavaScript
function 
beginEject(
participant, 
userCallback, 
state);

Parameters

participant
Type: Microsoft.Rtc.Collaboration . . :: . ConversationParticipant
The participant to eject.
userCallback
Type: AsyncCallback
The method to be called when the asynchronous operation is completed.
state
Type: Object
A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Return Value

An IAsyncResult that references the asynchronous operation.

Remarks

This operation is allowed by the server for conference leaders only.

Exceptions

Exception Condition
InvalidOperationException Thrown when the operation is not valid at the given conference session state.
ArgumentNullException Thrown when the participant argument was null.

See Also