RPAEngine.StopTask
The RPAEngine.StopTask method immediately stops the running task.
Syntax
RPAEngine.StopTask( _ Optional ByVal lngMessageType As Long = 0, _ Optional ByVal strMessage As String = "", _ Optional ByVal strTitle As String = "", _ Optional ByVal Style As VbMsgBoxStyle = vbExclamation) |
Parameters
lngMessageType
strMessage
strTitle
Style
|
Return Value
None. |
Remarks
The default message reads: "The script has been stopped." The default title reads: "Nintex RPA" |
Examples: The code below stops the script and displays the default stop message.
Call RPAEngine.StopTask(0) |
The code below stops the script and displays a custom message.
Call RPAEngine.StopTask(1, "My message here.", "My Title", vbExclamation) |
The code below stops the script without displaying a message.
Call RPAEngine.StopTask(2) |