Register Method (IEnumerable(SignalingHeader))

Synchronously registers the current endpoint.

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

Syntax

'Declaration
Public Function Register ( _
    signalingHeaders As IEnumerable(Of SignalingHeader) _
) As SipResponseData
'Usage
Dim instance As SipEndpoint
Dim signalingHeaders As IEnumerable(Of SignalingHeader)
Dim returnValue As SipResponseData

returnValue = instance.Register(signalingHeaders)
public SipResponseData Register(
    IEnumerable<SignalingHeader> signalingHeaders
)

Parameters

Return Value

Type: Microsoft.Rtc.Signaling..::..SipResponseData
Returns the [SipResponseData] from the server after a successful Register 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 occurs.

Remarks

This method waits until the Register operation is completed. It is not recommended for a UI thread.

See Also

Reference

SipEndpoint Class

SipEndpoint Members

Register Overload

Microsoft.Rtc.Signaling Namespace