BeginParticipate Method (AsyncCallback, Object)
Participates in a session.
Namespace: Microsoft.Rtc.Signaling
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginParticipate ( _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As SignalingSession
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginParticipate(userCallback, _
state)
public IAsyncResult BeginParticipate(
AsyncCallback userCallback,
Object state
)
Parameters
- userCallback
Type: System..::..AsyncCallback
The method to be called when the Participate operation is complete.
- state
Type: System..::..Object
The state to be passed back to the callback.
Return Value
Type: System..::..IAsyncResult
An [IAsyncResult] that references this operation.
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | Thrown when a non-nullNothingnullptrunita null reference (Nothing in Visual Basic) is expected for an argument. The argument name for which a non-nullNothingnullptrunita null reference (Nothing in Visual Basic) is expected is part of the exception message. |
RealTimeException | Thrown when some other failure occurs. |
ArgumentException | Thrown when invalid arguments are passed. |
InvalidOperationException | Thrown when the session is not in a valid state to accept or when Accept is called again while another Accept is pending. |
Remarks
This method needs to be called (for both outgoing and incoming messages) to establish the session.