Strobe method

Description

VWorks software calls the Strobe method to tell the plugin to activate the barcode reader and then read the barcode.

Syntax

 

HRESULT Strobe( [out] BSTR *bcrxml, [out,retval] enum ReturnCode *retVal );

Parameters

 

bcrxml	[out] A Barcode XML element containing the barcode that was read by the barcode reader.
retVal	[out, retval] Returns an error code. 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) For more information, see “ReturnCode enumerated type” .

Strobe method output

The plugin returns a Barcode XML element in the bcrxml parameter of the Strobe method. This XML element contains the barcode that was read by the barcode reader.

Barcode element

The Barcode element has the following attribute:

 

Name	Value
Barcode	The barcode. Required: Yes

Example of Strobe method output

The following sample code is a Barcode XML element that is returned to VWorks software by the plugin as a string in the bcrxml parameter of the Strobe method. The code contains the barcode that was read by the barcode reader.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='0090cbcd92e9e12d7dc90765978a7a0d' version='1.0' > <Barcode Barcode='barcode1' /> </Velocity11>