Asynchronously starts a new screen recording.

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 StartRecordingAsync(
	string userIdToRecord,
	EventHandler<StartRecordingCompletedEventArgs> completedCallback,
	Object userState
)
Visual Basic
Public Sub StartRecordingAsync ( _
	userIdToRecord As String, _
	completedCallback As EventHandler(Of StartRecordingCompletedEventArgs), _
	userState As Object _
)

Parameters

userIdToRecord
Type: System..::..String
The user whose screen will be recorded.
completedCallback
Type: System..::..EventHandler<(Of <(<'StartRecordingCompletedEventArgs>)>)>
The completed callback.
userState
Type: System..::..Object
An optional object that contains state information for this request. This object is a way for the caller to store context information which will be provided to the AsyncCompleted event. If no context information is desired then nullNothingnullptra null reference (Nothing in Visual Basic) may be supplied.

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. For more information on async method calls, see How Async Calls Work.

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionuserIdToRecord is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionuserIdToRecord length is zero.

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 SU 5 and beyond.

See Also