BeginRegister Method (IEnumerable(SignalingHeader), AsyncCallback, Object)

Starts an asynchronous Register operation for the current endpoint.

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

Syntax

'Declaration
Public Function BeginRegister ( _
    signalingHeaders As IEnumerable(Of SignalingHeader), _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult
'Usage
Dim instance As SipEndpoint
Dim signalingHeaders As IEnumerable(Of SignalingHeader)
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginRegister(signalingHeaders, _
    userCallback, state)
public IAsyncResult BeginRegister(
    IEnumerable<SignalingHeader> signalingHeaders,
    AsyncCallback userCallback,
    Object state
)

Parameters

Return Value

Type: System..::..IAsyncResult
An [IAsyncResult] that references this operation.

Exceptions

Exception Condition
RegisterException

Thrown when the registration fails.

ArgumentException

Thrown when one of the header in headers parameters is a restricted header.

InvalidOperationException

Thrown when the method is not called in the Unregistered state or the endpoint is terminated.

AuthenticationException

Thrown when a general authentication-related problem occurrs.

See Also

Reference

SipEndpoint Class

SipEndpoint Members

BeginRegister Overload

Microsoft.Rtc.Signaling Namespace