BX_AnalyzeParameters

Specifies the parameters that the barcode engine will use when analyzing an image for barcodes.

Declaration:

    typedef struct tagBX_AnalyzeParameters {
        long ParametersVersion;
        _Bool AppendCheckSum;
        BX_Rectangle Area;
        BX_BarcodeType BarcodeTypes;
        _Bool IncludeControlCharacters;
        BX_InkColor InkColor;
        long MaximumBarcodes;
        long MinimumBarcodeSize;
        BX_Orientation Orientation;
        _Bool ReturnPossibleBarcodes;
        BX_AustralianPostDecodeType AustralianPostDecodeType;
        _Bool RoyalMailVariableLengthDecoding;
        _Bool Code39StartStopPatternsAreMandatory;
        long ScanDistance;
        _Bool GrayscaleProcessing;
        _Bool AdditionalReadingPass;
    } BX_AnalyzeParameters;

Members:

Name	Type	Description
ParametersVersion	long	Specifies the version of the analyze parameters structure. The only valid value is 1. Do not change this to any other value.
AppendCheckSum	_Bool	Specifies if a checksum value is appended to the barcode during recognition. If this property is set to true, checksum values will be appended to the result for barcode types that require a checksum. This property does not have an effect on barcode types which do not have a checksum or for which the checksum is optional. The UPC and EAN codes always append the checksum character to the barcode results. This is done regardless of this property's value. Default value: false
Area	BX_Rectangle	Specifies the area of an image to analyze for barcode recognition. To search the entire image, all of the values must be set to 0. If any value is set, then they must all be set. The default value is {0,0,0,0}.
BarcodeTypes	BX_BarcodeType	Specifies the types of barcodes to search during the recognition process. By default, the barcode engine searches for all 1D barcodes. The 1D barcode set includes all types, except PatchCode, PostNet, GS1 DataBar, IntelligentMail, Royal Post Mail 4-State, Australian Post 4-State, QR Code, PDF417, Aztec and Data Matrix. Multiple types of barcodes can be searched for by setting this to the ORed value of the types desired. For example, to search for PDF417 and Code39 set the BarcodeTypes to BX_BarcodeType_Code39 \| BX_BarcodeType_PDF417. The default value is BX_BarcodeType_All1D.
IncludeControlCharacters	_Bool	Specifies if control characters are added to the barcode value. If this property is set to tue, the barcode control characters are included in the barcode read value. This has no effect for barcodes which do not support control characters.
InkColor	BX_InkColor	Specifies what color of the barcode to search for. The default value is BX_InkColor_Black.
MaximumBarcodes	long	Specifies the maximum number of barcodes to return. If more than this number of barcodes is found in the image, then the barcode engine will on return the number of barcodes specified. The minimum value is 1. The default value is 100.
MinimumBarcodeSize	long	Specifies the minimum size of a barcode to return. Setting this value to 0 indicates that any size barcode should be returned. Any of the 4 edges of a barcode may pass this minimum size test to be returned (eg. A MinimumBarcodeSize of 100 would return a barcode with edge-lengths of [80, 85, 90, 100] because the fourth edge length is greater-than-or-equal to the minimum size). The default value is 0.
Orientation	BX_Orientation	Specifies which direction to search for a barcode on the image. Set this value to expand or limit which direction to search for a barcode. For example, to only find barcodes that are oriented vertically set this to BX_Orientation_Vertical. Any barcodes that are oriented horizontally or diagonally will not be returned. The default value is BX_Orientation_HorizontalVertical.
ReturnPossibleBarcodes	_Bool	Specifies if the barcode engine should return possible barcodes. When this property is set to true, the barcode engine returns candidate barcodes which could not be decoded in the results list. The default value is false.
AustralianPostDecodeType	BX_AustralianPostDecodeType	Specifies the method of decoding the customer section for Australian Post 4 State barcode which supports a customer section in both the Customer Barcode 2 and Customer Barcode 3 formats. The default value is BX_AustralianPostDecodeType_NoCustomDecode.
RoyalMailVariableLengthDecoding	_Bool	Specifies whether or not to decode Royal Mail barcodes of any length. If set to false, only Royal Mail barcodes matching the lengths in the RM4SCC specification will be decoded. This is the default behavior.
Code39StartStopPatternsAreMandatory	_Bool	When property is set to true then only regular (barcode has both start and stop patterns) barcodes are recognized. When property is set to false then both regular and barcodes without start and stop patterns are recognized. This is relevant for Code39 and Code39 Extended barcode symbologies. The default value is true.
ScanDistance	long	Specifies the scan distance in pixels between line sweeps when searching for 1D barcodes. The default value is 5. Valid values are 1 up to and including 10.
GrayscaleProcessing	_Bool	Enables the direct analysis of grayscale image processing. When this value is set to true, the barcode engine will process a grayscale image along with a binarized version of the image. This step is strictly an extra analysis step. The default value is false.
AdditionalReadingPass	_Bool	Enables additional scaled (reduced) image processing. When this value is set to true, the barcode engine will reduce the original image and perform additional processing pass. After analyzing both these images, results from the second pass that are not present in the first pass will be reported. This step is strictly an extra analysis step which increases response time. It can be used for barcode images with repetitive noise artifacts around the bars which cause normal recognition pass to misread. The default value is false.