IVHooks methods overview

Use the following table to quickly locate an IVHooks method by name or by event.

 

Method	Event	See...
Aborted	A protocol run was aborted.	“Aborted method”
AvailablePlateList	Obsolete. This method should be implemented as return E_NOTIMPL (0x80004001).
BarCodeMisread	A barcode misread occurred.	“BarCodeMisread method”
BarCodeRead	A barcode read occurred.	“BarCodeRead method”
CompileComplete	A protocol was compiled.	“CompileComplete method”
CustomHook	A labware was inventoried.	“CustomHook method”
CustomMenuClick	Reserved for internal use. This method should be implemented as return E_NOTIMPL (0x80004001).
Deadlock	A deadlock occurred.	“Deadlock method”
Error	An error occurred in VWorks software.	“Error method”
FileOpened	A protocol file, runset file, or device file was opened.	“FileOpened method”
FileSaved	A protocol file, runset file, or device file was saved.	“FileSaved method”
GetPlateInfo	Obsolete. This method should be implemented as return E_NOTIMPL (0x80004001).
GetUserInterface	The user chose Tools  > Open Hooks Plugin for… in the VWorks main window and then clicked the plugin’s file name.	“GetUserInterface method”
LiquidTransferComplete	A liquid-transfer process was completed.	“LiquidTransferComplete method”
PipetProcessFinished	Obsolete. This method should be implemented as return E_NOTIMPL (0x80004001).
PipetProcessStarting	Obsolete. This method should be implemented as return E_NOTIMPL (0x80004001).
PipetTaskFinished	Obsolete. This method should be implemented as return E_NOTIMPL (0x80004001).
PipetTaskStarting	Obsolete. This method should be implemented as return E_NOTIMPL (0x80004001).
PlateGroupMapping	Obsolete. This method should be implemented as return E_NOTIMPL (0x80004001).
ProcessFinished	A process finished.	“ProcessFinished method”
ProcessStarting	A process started.	“ProcessStarting method”
ProtocolFinished	A protocol finished.	“ProtocolFinished method”
ProtocolPaused	A protocol is paused.	“ProtocolPaused method”
ProtocolStarted	A protocol started.	“ProtocolStarted method”
RobotMove	A robot is about to move away from its current location and to a new location.	“RobotMove method”
RobotPickComplete	A robot picked up a labware.	“RobotPickComplete method”
RobotPlaceComplete	A robot placed a labware.	“RobotPlaceComplete method”
ScriptPlateError	An error message was received from a script associated with a protocol.	“ScriptPlateError method”
TaskFinished	A task finished.	“TaskFinished method”
TaskStarting	A task started.	“TaskStarting method”
UserLoggedIn	A user logged in to VWorks software.	“UserLoggedIn method”
UserLoggedOut	A user logged out of VWorks software.	“UserLoggedOut method”