UserPinServices.BeginUpdatePin Method
Begins an asynchronous operation to set a new pin.
Namespace: Microsoft.Rtc.Collaboration.PinManagement
Assembly: Microsoft.Rtc.Collaboration (in Microsoft.Rtc.Collaboration.dll)
Syntax
'Declaration
Public Function BeginUpdatePin ( _
newPin As String, _
options As UpdatePinOptions, _
userCallback As AsyncCallback, _
state As Object _
) As IAsyncResult
'Usage
Dim instance As UserPinServices
Dim newPin As String
Dim options As UpdatePinOptions
Dim userCallback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult
returnValue = instance.BeginUpdatePin(newPin, _
options, userCallback, state)
public IAsyncResult BeginUpdatePin(
string newPin,
UpdatePinOptions options,
AsyncCallback userCallback,
Object state
)
Parameters
- newPin
Type: System.String
New pin to be set. Cannot be null or empty.
- options
Type: Microsoft.Rtc.Collaboration.PinManagement.UpdatePinOptions
The optional parameters to be used when setting new pin.
- 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 |
|---|---|
| ArgumentException | newPin parameter is null or empty. options parameter contains invalid or restricted signaling headers. |
| InvalidOperationException | Thrown when the endpoint is not in valid state to perform this operation. |