Asynchronously remove attributes from a recording.
Note: This method is supported for IC Server version 2016 R3 and beyond.
Assembly: ININ.IceLib.QualityManagement (in ININ.IceLib.QualityManagement.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public void RemoveRecordingAttributesAsync( string recordingId, IEnumerable<string> attributeNames, EventHandler<AsyncCompletedEventArgs> completedCallback, Object userState ) |
Visual Basic |
---|
Public Sub RemoveRecordingAttributesAsync ( _ recordingId As String, _ attributeNames As IEnumerable(Of String), _ completedCallback As EventHandler(Of AsyncCompletedEventArgs), _ userState As Object _ ) |
Parameters
- recordingId
- Type: System..::..String
The recording ID.
- attributeNames
- Type: System.Collections.Generic..::..IEnumerable<(Of <(<'String>)>)>
The names of the attributes to be removed from the recording.
- completedCallback
- Type: System..::..EventHandler<(Of <(<'AsyncCompletedEventArgs>)>)>
The callback to invoke when the asynchronous operation completes.
- userState
- Type: System..::..Object
An object that contains state information for this request.
Remarks
When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs - derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information.
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | recordingId is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..ArgumentException | recordingId length is zero. |
System..::..ArgumentNullException | attributeNames is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..ArgumentException | attributeNames is empty. |
ININ.IceLib.Connection..::..RequestTimeoutException | The request timed out while waiting for a response. |
ININ.IceLib.Connection..::..SessionDisconnectedException | The Session does not have a valid connection. |
System..::..ObjectDisposedException | The Session has been disposed. |
Version Information
Supported for IC Server version 2016 R3 and beyond.