Ignore method

Description

VWorks software calls the Ignore method as follows:

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 Ignore and Continue… button, VWorks software calls the Ignore method to tell the plugin to ignore the error.

The plugin should continue the task, if possible, or exit the task if continuing would be dangerous or impossible. A call to the Ignore method should not cause an unsafe condition, which could result in a new error or a premature completion of the task.

If all errors encountered during a task are ignored, the system should be able to continue as if the failing step was skipped.

Syntax

 

HRESULT Ignore( [out,retval] enum ReturnCode *retVal );

Parameter

 

retVal

[out, retval] Returns an error code. Possible values: 0 = The request was completed (RETURN_SUCCESS) 1 = Something was wrong with the input, so the request was not completed (RETURN_BAD_ARGS) 2 = The request was not completed (RETURN_FAIL) For more information, see “ReturnCode enumerated type” .

Related information

 

For information about...	See...
Abort method	“Abort method”
GetErrorInfo method	“GetErrorInfo method”
IWorksDiags ShowDiagsDialog method	“ShowDiagsDialog method”
Retry method	“Retry method”
ReturnCode enumerated type	“ReturnCode enumerated type”