GetBarCode (deprecated)

Member of namespace

Barcode_X

Syntax

GetBarCode ()

Parameters

None

Returns

Always True.

Level

Page or Field Level.

Details

Returns the value of any bar code within a zone. A rule set with this action can be applied to a Page object or Field object of the Document Hierarchy.

When applied to a Page object, the action reads the first bar code that it encounters on the page and creates a Page-level variable that is called GetBarCode, and places the bar code's value in the variable.

When applied to the Field object of a zoned field, the action assigns the bar code's value to the field.

• Barcode_X Datacap Studio Information: Use the Datacap Studio Zones tab to adjust the BAR/X properties of each bar code zone for optimal recognition.
• Barcode Type: It is important to set this property to the specific type of bar code that is expected. The default "All" searches for any 3of9, CODABAR, I2of5, Code 128, and Code 93 symbols, and returns spurious data in some cases.
• Orientation: Configures the expected orientation of the bar code. Horizontal is the normal orientation, where the bars are vertical within the overall symbol, which is wider than it is tall, and any printed text is below.
• Quality: This property is no longer used.
• Height / Width: This property is no longer used.
• Search Up To: The maximum number of bar codes that are expected within the field. Default is 1.
• Remove Spaces: If set to “Yes”, any white-space characters are removed from the final recognized string.
• Skip Recognition: If set to “Yes”, this field is skipped during recognition.

Example:

GetBarCode()
rr_Compare_Not("@VALUE, @EMPTY")

If you need to test that a barcode was read, you can use the action rr_Compare_Not(). This example shows how to perform that test on the field level.