CustomHook method

Event

A labware was inventoried.

Description

VWorks software calls the CustomHook method after the storage device inventories a labware. This method is for Liconic incubators that support only west-side barcodes.

Syntax

 

HRESULT CustomHook( [in] BSTR sXML, [in, out] BSTR* sResultXML );

Parameters

 

sXML	[in] An OnPlateInventoried XML element that contains information about the inventoried labware.
sResultXML	[in, out] A HookResults XML block. See “HookResults XML block” .

CustomHook method input

VWorks software passes an OnPlateInventoried XML element into the sXML parameter of the CustomHook method. This XML element provides the following information about the labware that was inventoried.

OnPlateInventoried element

The OnPlateInventoried element has the following attributes:

 

Name	Value
cassette	The number of the cassette.
slot	The number of the slot.
west_barcode	The barcode on the west side of the labware.
device_name	The device name.

Example of CustomHook method input

The following sample code is an OnPlateInventoried XML element that is received by the plugin from VWorks software as a string in the sXML parameter of the CustomHook method. The plugin returns information about the labware that was inventoried by the device named Store X Device Driver.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='PlateStorageInventory' md5sum='02ed84e9c28dad9cb815334189ba49ca' version='1.0' > <OnPlateInventoried cassette='1' slot='1' west_barcode='XUB89893-909' device_name='StoreX driver - 1' /> </Velocity11>

CustomHook method output

The plugin returns a HookResults XML block in the sResultXML parameter of the CustomHook method. For information about the structure and contents of this XML block, see “HookResults XML block” .

Example of CustomHook method output

The following sample code is a HookResults XML block that is returned to VWorks software by the plugin as a string in the sXML parameter of the CustomHook method. The plugin tells VWorks software to write the following Info-type message to the Main Log:

A microplate was inventoried.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='52226bb1b70c756162b551f1f5685a5d' version='1.0'> <HookResults> <Results> <HookResult ResultType='LogMessage' ResultValue='A microplate was inventoried.' /> </Results> </HookResults> </Velocity11>

Related information

 

For information about...	See...
HookResults XML block	“HookResults XML block”