Retry method

Description

VWorks software calls the Retry 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 Retry button, VWorks software calls the Retry method to tell the plugin to retry the task.

Because VWorks software assumes the user manually solved the problem that caused the error, the plugin should try to restart the task. The plugin should record the state of the task and retry from the point in the task that makes the most sense given the current state.

For example, a single-column dispenser that encounters an error after partially filling a labware should not start over, because the dispenser might deliver too much reagent to the already-covered wells. The dispenser should continue as close to the point of interruption as possible to avoid over-dispensing or under-dispensing the wells that were being filled at the time the error occurred.

Syntax

 

HRESULT Retry( [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”
Ignore method	“Ignore method”
PrepareForRun method	“PrepareForRun method”
ReturnCode enumerated type	“ReturnCode enumerated type”

  

3