Ignore method

Description

VWorks software calls the Ignore method as follows:

1	The plugin calls the ErrorAbortRetryIgnoreNonBlocking update to notify VWorks software that an error occurred and to provide a literal string that describes the error.

2	VWorks software does the following:

a	Writes the string to the Main Log.

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

•	The error string

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

The figure on page 41 shows 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 an asynchronous task are ignored, the system should be able to continue as if the failing step was skipped.

Syntax

 

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

Parameters

 

AsyncXML	[in] An Asynchronous Task Command XML block that identifies the asynchronous task and describes the error that occurred.
retVal	[out, retval] Returns an error code. For more information, see “ReturnCode enumerated type” . 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)

Ignore method input

VWorks software passes an Asynchronous Task Command XML block into the AsyncXML parameter of the Ignore method.

Asynchronous Task Command XML block

The Asynchronous Task Command XML block contains the Command element and an AsyncParameters child element and all its children. This XML block identifies the asynchronous task to be ignored and describes the error that occurred.

XML structure

The value of the file attribute for the Velocity11 element is MetaData. See “Velocity11 element” .

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11> <Command> <AsyncParameters> <AsyncParameter Name='Async_ErrorDescription' ... /> <AsyncParameter Name='Async_TaskID' ... /> <AsyncParameter Name='Async_TaskVWorksID' ... /> <AsyncParameter Name='Async_Location' ... /> </AsyncParameters> </Command> </Velocity11>

XML element and attributes

See “Asynchronous Task Command XML block components” .

Example of Ignore method input

The following code is an Asynchronous Task Command XML block received by the plugin from VWorks software as a string in the AsyncXML parameter of the Ignore method. VWorks software tells the plugin to ignore the error that occurred at the location named Location during the asynchronous task named MakeLocationAvailable, whose plugin-generated task ID is 1.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='89626582b55d53867fc461da1435da2d' version='1.0' > <Command Compiler='0' Editor='0' Name='MakeLocationAvailable' NextTaskToExecute='1' RequiresRefresh='0' TaskRequiresLocation='1' →VisibleAvailability='1' Description='MakeLocationAvailable' →ProtocolName='Protocol File - 1.pro'> <AsyncParameters > <AsyncParameter Name='Async_ErrorDescription' →Value='No response received from the pipette controller. It is recommended that you →click Retry. Ignoring this error may result in an unpredictable move.' /> <AsyncParameter Name='Async_TaskID' Value='1' /> <AsyncParameter Name='Async_TaskVWorksID' /> <AsyncParameter Name='Async_Location' Value='Location' /> </AsyncParameters> </Command> </Velocity11>

Related information

 

For information about...	See...
Abort method (IWorksAsyncDriver interface)	“Abort method”
GetListOfAsyncTasks method	“GetListOfAsyncTasks method”
Retry method (IWorksAsyncDriver interface)	“Retry method”