Asynchronously cancels the running process instances specified by the list of ProcessInstanceCancelData.
Note: This method is supported for IC Server version 2015 R3 and beyond.
Assembly: ININ.IceLib.ProcessAutomation (in ININ.IceLib.ProcessAutomation.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public void CancelProcessInstancesAsync( IEnumerable<ProcessInstanceCancelData> cancelData, EventHandler<AsyncCompletedEventArgs<ReadOnlyCollection<ProcessManager..::..CancelResults>>> completedCallback, Object userState ) |
Visual Basic |
---|
Public Sub CancelProcessInstancesAsync ( _ cancelData As IEnumerable(Of ProcessInstanceCancelData), _ completedCallback As EventHandler(Of AsyncCompletedEventArgs(Of ReadOnlyCollection(Of ProcessManager..::..CancelResults))), _ userState As Object _ ) |
Parameters
- cancelData
- Type: System.Collections.Generic..::..IEnumerable<(Of <(<'ProcessInstanceCancelData>)>)>
The process defined by ProcessInstanceCancelData.
- 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
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..ArgumentException | The target parameter was invalid. |
ININ.IceLib.Connection..::..RequestTimeoutException | The request timed out while waiting for a response. |
ININ.IceLib.Connection..::..SessionDisconnectedException | The Session does not have a valid connection. |
System..::..ObjectDisposedException | The Session has been disposed. |
Version Information
Supported for IC Server version 2015 R3 and beyond.