Asynchronously add recording attributes.

Note: This method is supported for IC Server version 2016 R3 and beyond.

Namespace: ININ.IceLib.QualityManagement
Assembly: ININ.IceLib.QualityManagement (in ININ.IceLib.QualityManagement.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public void AddRecordingAttributesAsync(
	string recordingId,
	IDictionary<string, string> attributes,
	EventHandler<AsyncCompletedEventArgs> completedCallback,
	Object userState
)
Visual Basic
Public Sub AddRecordingAttributesAsync ( _
	recordingId As String, _
	attributes As IDictionary(Of String, String), _
	completedCallback As EventHandler(Of AsyncCompletedEventArgs), _
	userState As Object _
)

Parameters

recordingId
Type: System..::..String
The recording ID.
attributes
Type: System.Collections.Generic..::..IDictionary<(Of <(<'String, String>)>)>
The attributes to be added to 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

Attribute names are case insensitive within Recorder Server, so an attribute name of "test" or "Test" will refer to the same attribute. If multiple attributes with the same name are added to a recording, only the first attribute will be added and the rest will be ignored as duplicates.

If an attribute is added that already exists on the recording, the value will not be updated.

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

ExceptionCondition
System..::..ArgumentNullExceptionrecordingId is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionrecordingId length is zero.
System..::..ArgumentNullExceptionattributes is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionattributes is empty.
ININ.IceLib.Connection..::..RequestTimeoutExceptionThe request timed out while waiting for a response.
ININ.IceLib.Connection..::..SessionDisconnectedExceptionThe Session does not have a valid connection.
System..::..ObjectDisposedExceptionThe Session has been disposed.

Version Information

Supported for IC Server version 2016 R3 and beyond.

See Also