IWorksDriver methods overview

Use the following table to quickly locate an IWorksDriver method by name or by description.

 

Method	Description	See...
Abort	Tells the plugin to terminate a task or to terminate all currently executing tasks.	“Abort method”
Close	Tells the plugin to terminate the connection to a device.	“Close method”
Command	Tells the plugin to execute a task.	“Command method”
Compile	Notifies the plugin of the state of a protocol’s compile sequence.	“Compile method”
ControllerQuery	Provides the means for plugin-to-plugin communication.	“ControllerQuery method”
Get32x32Bitmap	Gets a 32x32 bitmap image from the plugin to display for a device or task in the protocol editor.	“Get32x32Bitmap method”
GetDescription	Gets a dynamic description or a detailed description for a task from the plugin.	“GetDescription method”
GetErrorInfo	Gets a text string describing the error that occurred when the plugin returned an error code; writes the string to the Main Log; and displays the standard error dialog box, which contains the string.	“GetErrorInfo method”
GetLayoutBitmap	Gets a dynamic bitmap from the plugin that shows the labware located on a device.	“GetLayoutBitmap method”
GetMetaData	Gets information about the plugin as XML metadata, or notifies the plugin of changes that the user made to device or task parameters.	“GetMetaData method”
Ignore	Tells the plugin to ignore an error that occurred during a task.	“Ignore method”
Initialize	Tells the plugin to initialize a device.	“Initialize method”
IsLocationAvailable	Asks the plugin whether a location is available for a labware-handling process.	“IsLocationAvailable method”
MakeLocationAvailable	Tells the plugin to make a location available for a labware-handling process.	“MakeLocationAvailable method”
PlateDroppedOff	Notifies the plugin that a labware was dropped off.	“PlateDroppedOff method”
PlatePickedUp	Notifies the plugin that a labware was picked up.	“PlatePickedUp method”
PlateTransferAborted	Notifies the plugin that a labware-transfer process was aborted.	“PlateTransferAborted method”
PrepareForRun	Notifies the plugin that the user started a protocol.	“PrepareForRun method”
Retry	Tells the plugin to retry a task.	“Retry method”
ShowDiagsDialog	Obsolete. This method should be implemented as return E_NOTIMPL (0x80004001). Instead of this method, VWorks software calls the IWorksDiags ShowDiagsDialog method to display a diagnostics dialog box. See IWorksDiags “ShowDiagsDialog method” .