BX_BarcodeResult

Contains the result of a single detected barcode.

Declaration:

	Copy Code
typedef struct tagBX_BarcodeResult { BX_Rectabgle Area; BX_Point Point1; BX_Point Point2; BX_Point Point3; BX_Point Point4; long Confidence; char* Name; long NameLength; long Skew; BX_BarcodeType BarcodeType; _Bool CheckSumValid; long CheckSumLength; char* Value; long ValueLength; BX_ModeTransition* ModeTransitions; long ModeTransitionsLength; } BX_BarcodeResult;

Copy Code

typedef struct tagBX_BarcodeResult {
    BX_Rectabgle Area;
    BX_Point Point1;
    BX_Point Point2;
    BX_Point Point3;
    BX_Point Point4;
    long Confidence;
    char* Name;
    long NameLength;
    long Skew;
    BX_BarcodeType BarcodeType;
    _Bool CheckSumValid;
    long CheckSumLength;
    char* Value;
    long ValueLength;
    BX_ModeTransition* ModeTransitions;
    long ModeTransitionsLength;
} BX_BarcodeResult;

Members:

Area

BX_Rectangle

Specifies a rectangular area on the image containing the barcode.

This area does not necessarily correspond to the corner points of a barcode.

Point1

BX_Point

Specifies the upper-left corner point of the barcode.

Point2

BX_Point

Specifies the upper-right corner point of the barcode.

Point3

BX_Point

Specifies the lower-right corner point of the barcode

Point4

BX_Point

Specifies the lower-left corner point of the barcode.

Confidence

long

Specifies the confidence value that the barcode result is accurate.

Confidence values of 30 indicate that the barcode value could not be determined accurately.

Name

char*

Specifies the name of the barcode detected.

This is a string representation of the barcode-type.

NameLength

long

Specifies the length of the barcode name string.

Skew

long

Specifies the angle of skew for the recognized barcode.

The skew angle is measured in degrees, with 0 degrees being horizontal. It is measured from the horizontal axis to the top edge of the barcode.

BarcodeType

BX_BarcodeType

Specifies the type of barcode that is detected.

If a barcode is not decoded and ReturnPossibleBarcodes is true, then the BarcodeType returned is BX_BarcodeType_Unknown.

CheckSumValid

_Bool

Specifies if the checksum for the recognized barcode is valid.

For barcodes with a checksum, it returns whether the checksum is valid.

For barcodes without a checksum, it returns false

For barcodes with error correction, it returns true.

CheckSumLength

long

Specifies the number of characters in the recognized checksum.

Value

char*

Specifies a string containing the value of a recognized barcode.

ValueLength

long

Specifies the length (or number of characters) in the recognized barcode value.

ModeTransitions

BX_ModeTransition*

Specifies the Mode Transitions for barcodes that support it.

When reading a barcode, many symbologies will go through state changes that may give extra context about the content types inside the barcode (eg. Kanji).
This gives the user extra information about the inner workings of the barcode's state.

Currently only enabled with QR Codes.

ModeTransitionsLength

long

Specifies the number of transitions detected in the barcode.