BARCODEDATA

Summary

This structure contains barcode information.

Syntax

typedef struct tagBarCodeData 
{ 
   L_UINT uStructSize; 
   L_INT nGroup; 
   L_UINT32 ulType; 
   L_INT nUnits; 
   RECT rcBarLocation; 
   L_INT nSizeofBarCodeData; 
   L_CHAR * pszBarCodeData; 
   L_INT nIndexDuplicate; 
   L_INT nTotalCount; 
   L_INT nDupCount; 
   L_UINT uFlags; 
   L_UINT uDataCode; 
   L_INT nAngle; 
   L_INT nBWR; 
   POINT Vertices[4]; 
} BARCODEDATA,* pBARCODEDATA; 

Members

uStructSize

Size of BARCODEDATA structure, in bytes, for versioning. Use the sizeof operator to calculate this value.

nGroup

Specifies whether the barcode symbol is a member of a group of symbols. This member is used for reading PDF417 symbols.

ulType

Barcode type. Possible values are:

Linear (1D) barcode symbols

Patch Code barcode symbol

Postal barcode symbols

4 State barcode symbols

GS1 Databar (formerly RSS14) Stacked barcode symbols

PDF417 barcode symbol

MicroPDF417 barcode symbol

Data Matrix barcode symbol

QR barcode symbol

Other barcode symbol

nUnits

Unit of measure for the rcBarLocation member. Possible values are:

rcBarLocation

The barcode location on the bitmap.

nSizeofBarCodeData

Barcode data size. If it is zero, the string length will be considered as data size.

pszBarCodeData

Pointer to the barcode data string.

nIndexDuplicate

Index to the next duplicated barcode. This member will be filled only by L_BarCodeRead or L_BarCodeReadExt function. Possible values are:

nTotalCount

Total barcode count found by L_BarCodeRead or L_BarCodeReadExt function.

nDupCount

Total count of barcodes duplicated for the current barcode. This member is filled by the L_BarCodeRead or L_BarCodeReadExt function.

uFlags

Flags. This member will be filled only by L_BarCodeRead or L_BarCodeReadExt function. Possible value is:

uDataCode

MicroPDF417 start code word function for Code128 emulation. This member will be filled by the L_BarCodeRead or L_BarCodeReadExt function when reading a MicroPDF417 symbol.

nAngle

Barcode angle in degrees. Values range from -18000 to 18000 with two-digit precision. To obtain the real value, divide nAngle by 100. This value is reported when the barcode is read, and it is not used for writing.

nBWR

Bar width reduction value, in micrometers, for each black bar in the barcode. It is reported when the barcode is read, and it is not used for writing.

Vertices

The polygon which represents the vertices X/Y coordination of the barcode on the bitmap by this sequence (top left, top right, bottom right, bottom left).

This value has to be updated just for 1D and QR types of barcodes.

Comments

This structure will be filled by L_BarCodeRead or L_BarCodeReadExt when reading in barcode information.

You can also fill this structure before calling L_BarCodeWrite to print the barcode symbol on the bitmap.

There is no limitation on the barcode angle, i.e., all angles can be detected,( whereas the deskew command is limited to +/- 20 degrees). It is very useful to detect the document image skew angle to correct the image angle. Provide this angle to deskew the image or rotate the image in the reverse direction.

Australian post barcode strings have a special format to distinguish different fields (i.e., FCC, DPID, and CIF). The string format puts dashes between fields as follows:  FCC-DIPD-CIF, where FCC is a 2-digit field (valid values are 11, 87, 45, 92, 59, 62, and 44), DPID is an 8-digit field representing the address, and CIF (optional) represents the customer information field. For more information, refer to the standard. This string format applies to both reading and writing.

GS1 Databar (formerly RSS14) Expanded and Expanded Stacked strings need to be written conforming to a string format that indicates a particular encoding method, such as Method 1, Method 0100, or Method 0101. For example, suppose a string (01)00012345678905(10)ABC123 is encoded using Method 1  (i.e., General Identification Data). In this example the 14th digit of the item identification number (in this case, "5"), if it exists, is considered as a check digit and is ignored. A string that is written without following any of these special encoding formats will be encoded by Method 00 (i.e., General Purpose Data).

When read, an extra digit in curly brackets (i.e., { and }) is added to indicate the linkage bit at the beginning of the string. The curly brackets are not part of the encoded barcode data, and they are not defined in the standard. Rather, they distinguish the linkage digit from other data. For example, if a barcode is written with string (01)00012345678905(10)ABC123 while the linkage bit is set to zero, the read function result will be {0}(01)00012345678905(10)ABC123, where {0} is the linkage digit and the remaining characters are the barcode data.

NOTES:

• Type RSS14 is now GS1 Databar. All references to RSS14 now refer to GS1 Databar.

• Code Interleaved 2 of 5: I = # of digits and must be even.

• Linear barcodes are not supported in UNICODE.

For a table containing information useful when writing 1D barcode data see Writing Linear 1D Barcodes.

Usage

• L_BarCodeFree
• L_BarCodeGetDuplicated
• L_BarCodeGetFirstDuplicated
• L_BarCodeGetNextDuplicated
• L_BarCodeIsDuplicated
• L_BarCodeRead
• L_BarCodeReadExt
• L_BarCodeWrite