QueryStorageLocations method

Description

VWorks software calls the QueryStorageLocations method when the user requests an inventory using the Inventory Editor. The method provides the plugin with a starting cassette/slot and ending cassette/slot. All slots between the start and end are inventoried.

After the plugin performs the inventory, it returns the results of the inventory by creating an InventoryPlateBarcode update with a call to the IWorksController Update method. See “InventoryPlateBarcodes update” .

Syntax

 

HRESULT QueryStorageLocations( [in] BSTR QueryXML, [out,retval] enum ReturnCode *retVal );

Parameters

 

QueryXML	[in] A Velocity11 XML element that specifies the coordinates of the range of labware to be inventoried.
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)

QueryStorageLocations method input

VWorks software passes a Velocity11 XML element into the QueryXML parameter of the QueryStorageLocations method. This XML element provides the coordinates of the range of labware to be inventoried.

Velocity11 element

The Velocity11 element has the following attributes:

 

Name	Value
EndCassette	The cassette at the end of the labware range.
EndSlot	The slot at the end of the labware range.
StartCassette	The cassette at the beginning of the labware range.
StartSlot	The slot at the beginning of the labware range.
file	The value PlateStorageInventory.

Example of QueryStorageLocations method input

The following sample code is a Velocity11 XML element received by the plugin from VWorks software as a string in the QueryXML parameter of the QueryStorageLocations method. VWorks software tells the plugin to inventory the labware at the specified coordinates. The range includes all slots from the start cassette/slot to the end casette/slot.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 EndCassette='2' EndSlot='1' StartCassette='2' StartSlot='1' →file='PlateStorageInventory' md5sum='30a2242fee50dbc4d5e2b2df229e7574' →version='1.0' />

Related information

 

For information about...	See...
InventoryPlateBarcodes update (IWorksController Update method)	“InventoryPlateBarcodes update”
ReturnCode enumerated type	“ReturnCode enumerated type”