Abort method

Description

VWorks software calls the Abort method to terminate a specific task or to terminate all currently executing tasks.

To terminate a specific task

1	The plugin notifies VWorks software that an error occurred during a task.

2	VWorks software does the following:

a	Calls the GetErrorInfo method to get a text string from the plugin that describes the error. See “GetErrorInfo method” .

b	Writes the string to the Main Log.

c	Displays the standard error dialog box, which includes the following components:

•	The error text string.

•	The Abort, Retry, and Ignore and Continue… buttons.

See “GetErrorInfo method” for a picture of a standard error dialog box.

3	If the user clicks the Abort button, VWorks software calls the Abort method to tell the plugin to terminate the task.

To terminate all currently executing tasks

When the user aborts a run in the Runset Manager, VWorks software calls the Abort method to tell the plugin to terminate all currently executing tasks.

Note: This is not an emergency stop.

Syntax

 

HRESULT Abort(void);

Parameters

None.

Related information

 

For information about...	See...
GetErrorInfo method	“GetErrorInfo method”
Ignore method	“Ignore method”
IWorksDiags ShowDiagsDialog method	“ShowDiagsDialog method”
PrepareForRun method	“PrepareForRun method”
Retry method	“Retry method”