GetErrorInfo method

Description

VWorks software calls the GetErrorInfo method when the plugin returns a value other than RETURN_SUCCESS for a method with a retVal output parameter of type ReturnCode. See “ReturnCode enumerated type” .

When the plugin notifies VWorks software that an error occurred during a task, VWorks software does the following:

1	Calls the GetErrorInfo method to get a text string from the plugin that describes the error.

2	Writes the string to the Main Log.

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

•	The error text string

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

The following figure shows a standard error dialog box for the 3-Axis Robot.

Figure Standard error dialog box

 

Syntax

 

HRESULT GetErrorInfo( [out,retval] BSTR *ErrorInfoXML );

Parameter

 

ErrorInfoXML

[out, retval] A text string that describes the error. Agilent Technologies does not currently support error codes. The plugin developer can embed error codes in this parameter.

Related information

 

For information about...	See...
Compile method	“Compile method”
CompileType enumerated type	“CompileType enumerated type”
IWorksDiags ShowDiagsDialog method	“ShowDiagsDialog method”
IWorksDriver Abort method	“Abort method”
IWorksDriver Ignore method	“Ignore method”
IWorksDriver Retry method	“Retry method”
ReturnCode enumerated type	“ReturnCode enumerated type”