Cancels the running process instances specified by the list of ProcessInstanceCancelData.

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

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

Syntax

C#
public ReadOnlyCollection<ProcessManager..::..CancelResults> CancelProcessInstances(
	IEnumerable<ProcessInstanceCancelData> cancelData
)
Visual Basic
Public Function CancelProcessInstances ( _
	cancelData As IEnumerable(Of ProcessInstanceCancelData) _
) As ReadOnlyCollection(Of ProcessManager..::..CancelResults)

Parameters

cancelData
Type: System.Collections.Generic..::..IEnumerable<(Of <(<'ProcessInstanceCancelData>)>)>
The process defined by ProcessInstanceCancelData.

Return Value

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

Exceptions

ExceptionCondition
System..::..ArgumentNullExceptionA parameter is nullNothingnullptra null reference (Nothing in Visual Basic).
System..::..ArgumentExceptionThe target parameter was invalid.
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 2015 R3 and beyond.

See Also