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 ReadOnlyCollection<ProcessManager..::..CancelResults> CancelProcessInstances(
	ICollection<long> numericIds,
	ICollection<string> cancelReasons
)
Visual Basic
<ObsoleteAttribute("This method has been deprecated, use the overload that uses an IEnumerable<ProcessInstanceCancelData> instead.")> _
Public Function CancelProcessInstances ( _
	numericIds As ICollection(Of Long), _
	cancelReasons As ICollection(Of String) _
) As ReadOnlyCollection(Of ProcessManager..::..CancelResults)

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.

Return Value

A ReadOnlyCollection<(Of <(<'T>)>)> of ProcessManager..::..CancelResults objects.

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