ConferenceSession.BeginEject Method (ConversationParticipant, AsyncCallback, Object)

Ejects all endpoints of a participant from the conference.

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

Syntax

'Declaration
Public Function BeginEject ( _
    participant As ConversationParticipant, _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As ConferenceSession
Dim participant As ConversationParticipant
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginEject(participant, _
    userCallback, state)
public IAsyncResult BeginEject(
    ConversationParticipant participant,
    AsyncCallback userCallback,
    Object state
)

Parameters

  • userCallback
    Type: System.AsyncCallback
    The method to be called when the asynchronous operation is completed.
  • state
    Type: System.Object
    A user-provided object that distinguishes this particular asynchronous operation from other asynchronous operations.

Return Value

Type: System.IAsyncResult
An IAsyncResult that references the asynchronous operation.

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.

Remarks

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

See Also

Reference

ConferenceSession Class

ConferenceSession Members

BeginEject Overload

Microsoft.Rtc.Collaboration Namespace