BARCODE1D

Summary

This structure contains linear (1D) barcode information for reading or writing 1D barcodes.

Syntax

typedef struct _tagBarCode1D 
{ 
   L_UINT uStructSize; 
   L_BOOL bOutShowText; 
   L_INT nDirection; 
   L_BOOL bErrorCheck; 
   L_INT nGranularity; 
   L_INT nMinLength; 
   L_INT nMaxLength; 
   L_INT nWhiteLines; 
   L_UINT uStd1DFlags; 
   L_UINT uAdvancedFlags; 
   L_INT nXModule; 
} BARCODE1D,* pBARCODE1D; 

Members

uStructSize

Size of BARCODE1D structure in bytes. Use the sizeof operator to calculate this value.

bOutShowText

Indicates whether the barcode string will be shown or not. This member is valid for the L_BarCodeWrite function. Possible values are:

nDirection

Flag that indicates the orientation and direction for reading barcodes. This member is valid for the L_BarCodeRead or L_BarCodeReadExt. You can combine values when appropriate, by using a bitwise OR ( | ). Possible values are :

bErrorCheck

Enables or disables the use of an error check digit while reading or writing a barcode.

nGranularity

Number of scanned lines per column to skip when reading a barcode. 9 is the default value. This means that each tenth line will be scanned when looking for a barcode. Scanning every line will slow the search process while skipping too many lines may skip over the barcode. This member is valid for the L_BarCodeRead or L_BarCodeReadExt function.

nMinLength

The minimum length of a barcode string when searching for a non-fixed-length barcode. A value of 0 sets the engine to the default length of 4 characters. The minimum number of characters is 0 and the maximum 63. This member is valid for the L_BarCodeRead or L_BarCodeReadExt function. A value of 1 sets the engine to read all barcodes.

nMaxLength

The maximum length of a barcode string when searching for a non-fixed-length barcode. A value of 0 means the length can be any value up to the maximum allowed (63). The minimum value is 0 and the maximum is 63. The default value is 0.

nWhiteLines

The number of lines of white space above and below the barcode symbol.

nXModule

Specifies the size of the smallest bar to write, in thousandths of an inch (0.001), if BARCODE_1D_USE_XMOD flag is set. This flag is available in LEADTOOLS version 16.

uStd1DFlags

Flags that indicate the MSI barcode type, Code11 barcode type, and reading speed. You can use a bitwise OR ( | ) to specify one flag from each group.

MSI barcode type to be read or written:

Code11 barcode type to be read or written:

Reading speed flags (for reading only):

Code 128 encoding table to be used in barcode writing (for writing Code 128 only):

The position of the barcode's text for writing a standard linear (1D) barcode (for writing only):

uAdvancedFlags

Flags that indicate linkage bit value for all GS1 Databar (formerly RSS14) barcode types; direction of  GS1 Databar (formerly RSS14) Stacked and Truncated types, number of  GS1 Databar (formerly RSS14) Expanded Stacked rows to write, and Australian post CIF table for read and write. Combine values to specify one flag from each group by using a bitwise OR ( | ). Possible values are:

Linkage bit for GS1 Databar (formerly RSS14), Limited, Expanded, Stacked, and Expanded Stacked barcodes (write only):

GS1 Databar (formerly RSS14) two-row (Stacked) format (write only):

GS1 Databar (formerly RSS14) Truncated format (write only):

Determine the number of rows to write for GS1 Databar (formerly RSS14) Expanded Stacked format (write only):

Australian post customer information field (CIF) encoding/decoding table flags (read/write):

Comments

pBARCODE1D is a pointer to an BARCODE1D structure. Where the function parameter type is pBARCODE1D, you can declare a BARCODE1D variable, update the structure's fields, and pass the variable's address in the parameter. Declaring a pBARCODE1D variable is necessary only if your program requires a pointer.

The Linear barcodes are not supported in UNICODE.

A barcode is composed of start mark, data, and end mark. Reading barcodes from left to right (passing BARCODE_DIR_LEFT_TO_RIGHT value to the nDirection member) or from right to left (passing BARCODE_DIR_RIGHT_TO_LEFT value to the nDirection member) will produce the same result in most cases, because the barcode reader engine recognizes the start and end marks, and handles the data accordingly.

For example, if BARCODE_DIR_LEFT_TO_RIGHT is passed and the user reads barcodes from left to right (the barcode is not rotated), the engine will recognize the start mark first, then the data, and finally the end mark.

But if the user reads barcodes from right to left (the barcode is rotated 180 degrees), the engine will first recognize the end mark, then read the (reverse-order) data, and then recognize the start mark. In this case, the engine will flip the data to normal (start/data/end) order.

Some  GS1 Databar (formerly RSS14) Expanded Stacked strings have a fixed number of symbols. L_BarCodeWrite returns ERROR_BARCODE_STRING if the number of rows does not fit.

For a table containing information for writing linear 1D barcodes, refer to: Writing Linear 1D Barcodes.

NOTE: Type RSS14 has been renamed GS1 Databar. All references to RSS14 now refer to GS1 Databar.

Usage

• L_BarCodeRead
• L_BarCodeReadExt
• L_BarCodeWrite