SipEndpoint.BeginRegister Method (Generic IEnumerable, AsyncCallback, Object)

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Starts an asynchronous Register operation for the current endpoint.

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

Syntax

'Declaration
<EditorBrowsableAttribute(EditorBrowsableState.Advanced)> _
Public Function BeginRegister ( _
    signalingHeaders As IEnumerable(Of SignalingHeader), _
    userCallback As AsyncCallback, _
    state As Object _
) As IAsyncResult

[EditorBrowsableAttribute(EditorBrowsableState.Advanced)] 
public IAsyncResult BeginRegister (
    IEnumerable<SignalingHeader> signalingHeaders,
    AsyncCallback userCallback,
    Object state
)

Parameters

• signalingHeaders

• userCallback
  The callback to be invoked when the Register operation is complete.

• state
  The state to be passed back to the callback.

Return Value

An IAsyncResult that references this operation.

Exceptions

Exception type	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.

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

SipEndpoint Class
SipEndpoint Members
Microsoft.Rtc.Signaling Namespace