Asynchronously cancels process instances specified by the list of numeric IDs.

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

Syntax

C#
[ObsoleteAttribute("This method has been deprecated, use the overload that uses an IEnumerable<ProcessInstanceCancelData> instead.")]
public void CancelProcessInstancesAsync(
	ICollection<long> numericIds,
	ICollection<string> cancelReasons,
	EventHandler<AsyncCompletedEventArgs<ReadOnlyCollection<ProcessManager..::..CancelResults>>> completedCallback,
	Object userState
)
Visual Basic
<ObsoleteAttribute("This method has been deprecated, use the overload that uses an IEnumerable<ProcessInstanceCancelData> instead.")> _
Public Sub CancelProcessInstancesAsync ( _
	numericIds As ICollection(Of Long), _
	cancelReasons As ICollection(Of String), _
	completedCallback As EventHandler(Of AsyncCompletedEventArgs(Of ReadOnlyCollection(Of ProcessManager..::..CancelResults))), _
	userState As Object _
)

Parameters

numericIds
Type: System.Collections.Generic..::..ICollection<(Of <(<'Int64>)>)>
The process definition numeric IDs. These numeric IDs can be found in NumericId.
cancelReasons
Type: System.Collections.Generic..::..ICollection<(Of <(<'String>)>)>
The reasons the processes were canceled.
completedCallback
Type: System..::..EventHandler<(Of <(<'AsyncCompletedEventArgs<(Of <(<'ReadOnlyCollection<(Of <(<'ProcessManager..::..CancelResults>)>)>>)>)>>)>)>
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

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentOutOfRangeExceptionA parameter did not have did not contain the right number of elements.

Version Information

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

See Also