imaqReadDataMatrixBarcode

Usage

Barcode2DInfo* imaqReadDataMatrixBarcode(const Image* image, const ROI* roi, const DataMatrixOptions* options, unsigned int* numBarcodes);

Purpose

Reads Data Matrix barcodes from an image.

Note  This function is obsolete. The replacement function is imaqReadDataMatrixBarcode2(), which uses an increase in input parameters to offer better reliability and performance, as well as the ability to prepare images for data matrix grading.

Image Types Supported

IMAQ_IMAGE_U8

Parameters

Name	Type	Description
image	const Image*	The image containing the barcodes to read.
roi	const ROI*	A region of interest specifying the location of the barcodes in the image. The first contour of roi must be a rectangle, rotated rectangle, oval, annulus or closed contour. Set this parameter to NULL to use the entire image.
options	const DataMatrixOptions*	Describes how to search for the Data Matrix barcode.
numBarcodes	unsigned int*	On return, the number of barcodes that the function found. Set this parameter to NULL if you do not need this information.

Return Value

Type	Description
Barcode2DInfo*	On success, this function returns an array of structures containing information about the barcodes. On failure, this function returns NULL. To get extended error information, call imaqGetLastError(). When you are finished with this array, dispose of it by calling imaqDispose().

Parameter Discussion

options—Set the options parameter to NULL to use the default options, as follows:

searchMode	IMAQ_SEARCH_SINGLE_CONSERVATIVE
contrast	IMAQ_ALL_BARCODE_2D_CONTRASTS
cellShape	IMAQ_SQUARE_CELLS
barcodeShape	IMAQ_SQUARE_BARCODE_2D
subtype	IMAQ_ALL_DATA_MATRIX_SUBTYPES