CBarcodeDetection_interface.h File Reference

Interface for CBarcodeDetection wrapper. More...

Go to the source code of this file.

Functions
CBarcodeDetection	CBarcodeDetection_Create (const CIDRS argIdrs, idrs_exception *pargException)
	Creates a new instance of this class and associates the provided.
CBarcodeDetection	CBarcodeDetection_Create2 (const CIDRS argIdrs, const CBarcodeParams argBarcodeParams, idrs_exception *pargException)
	Creates a new instance of this class and associates the provided.
CBarcodeParams	CBarcodeDetection_GetBarcodeParams (const CBarcodeDetection argCBarcodeDetection, idrs_exception *pargException)
	Gets the parameters used for the detection (barcode type(s), full page/zonal recognition, etc)
void	CBarcodeDetection_SetBarcodeParams (CBarcodeDetection argCBarcodeDetection, const CBarcodeParams argBarcodeParams, idrs_exception *pargException)
	Sets the parameters used for barcode detection.
IProgressPageProcessing	CBarcodeDetection_GetProgressCallback (const CBarcodeDetection argCBarcodeDetection, idrs_exception *pargException)
	Gets the callback used to notify about barcode detection progress.
void	CBarcodeDetection_SetProgressCallback (CBarcodeDetection argCBarcodeDetection, IProgressPageProcessing argpProgressCallback, idrs_exception *pargException)
	Sets the callback used to notify about barcode detection progress.
CBarcodeArray	CBarcodeDetection_DetectBarcodes (const CBarcodeDetection argCBarcodeDetection, const CImage argImage, idrs_exception *pargException)
	Runs barcode detection and returns the detected barcodes.
void	CBarcodeDetection_DetectBarcodes2 (const CBarcodeDetection argCBarcodeDetection, CPage argPage, idrs_exception *pargException)
	Runs barcode detection and returns the detected barcodes.
void	CBarcodeDetection_Destroy (CBarcodeDetection argCBarcodeDetection, idrs_exception *pargException)
	Destroys a CBarcodeDetection handle.

Detailed Description

Interface for CBarcodeDetection wrapper.

Function Documentation

CBarcodeDetection_Create()

CBarcodeDetection CBarcodeDetection_Create	(	const CIDRS	argIdrs,
		idrs_exception *	pargException
	)

Creates a new instance of this class and associates the provided.

See also

CIDRS handle to it.

Parameters

argIdrs	CIDRS instance
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeDetection_Create2()

CBarcodeDetection CBarcodeDetection_Create2	(	const CIDRS	argIdrs,
		const CBarcodeParams	argBarcodeParams,
		idrs_exception *	pargException
	)

Creates a new instance of this class and associates the provided.

See also

CIDRS handle and barcode detection parameters

Parameters

argIdrs	CIDRS instance
argBarcodeParams	Object containing the barcode detection parameters
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeDetection_Destroy()

void CBarcodeDetection_Destroy	(	CBarcodeDetection	argCBarcodeDetection,
		idrs_exception *	pargException
	)

Destroys a CBarcodeDetection handle.

Parameters

argCBarcodeDetection	CBarcodeDetection handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeDetection_DetectBarcodes()

CBarcodeArray CBarcodeDetection_DetectBarcodes	(	const CBarcodeDetection	argCBarcodeDetection,
		const CImage	argImage,
		idrs_exception *	pargException
	)

Runs barcode detection and returns the detected barcodes.

Parameters

argCBarcodeDetection	CBarcodeDetection handle
argImage	Image on which barcode detection will be run
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

Detected barcodes

CBarcodeDetection_DetectBarcodes2()

void CBarcodeDetection_DetectBarcodes2	(	const CBarcodeDetection	argCBarcodeDetection,
		CPage	argPage,
		idrs_exception *	pargException
	)

Runs barcode detection and returns the detected barcodes.

Parameters

argCBarcodeDetection	CBarcodeDetection handle
argPage	Page on which barcode detection will be run. The page object data will be updated with the recognized barcodes.
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeDetection_GetBarcodeParams()

CBarcodeParams CBarcodeDetection_GetBarcodeParams	(	const CBarcodeDetection	argCBarcodeDetection,
		idrs_exception *	pargException
	)

Gets the parameters used for the detection (barcode type(s), full page/zonal recognition, etc)

By default, the barcode detection runs on full page with all barcode types enabled (depends on enabled extensions)

Returns

Parameters used for barcode detection.

Parameters

argCBarcodeDetection	CBarcodeDetection handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeDetection_GetProgressCallback()

IProgressPageProcessing CBarcodeDetection_GetProgressCallback	(	const CBarcodeDetection	argCBarcodeDetection,
		idrs_exception *	pargException
	)

Gets the callback used to notify about barcode detection progress.

The callback mechanism also allows stopping the barcode detection. See

See also

CProgressBarcodeDetection for more details

By default, there's no callback defined for barcode detection, so the returned value will be NULL

Returns

Pointer to the current progress callback object.

Parameters

argCBarcodeDetection	CBarcodeDetection handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeDetection_SetBarcodeParams()

void CBarcodeDetection_SetBarcodeParams	(	CBarcodeDetection	argCBarcodeDetection,
		const CBarcodeParams	argBarcodeParams,
		idrs_exception *	pargException
	)

Sets the parameters used for barcode detection.

By default, the barcode detection runs on full page with all barcode types enabled (depends on enabled extensions)

Parameters

argCBarcodeDetection	CBarcodeDetection handle
argBarcodeParams	Parameters used for barcode detection.
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeDetection_SetProgressCallback()

void CBarcodeDetection_SetProgressCallback	(	CBarcodeDetection	argCBarcodeDetection,
		IProgressPageProcessing	argpProgressCallback,
		idrs_exception *	pargException
	)

Sets the callback used to notify about barcode detection progress.

The callback mechanism also allows stopping the barcode detection. See

See also

CProgressBarcodeDetection for more details

Please make sure that the provided object lifetime spans the duration of the barcode detection progress. Deleting the object pointed by argpProgressCallback before/while the barcode detection is running might result in a crash.

By default, there's no callback defined for barcode detection, so the returned value will be NULL

Parameters

argCBarcodeDetection	CBarcodeDetection handle
argpProgressCallback	Pointer to the progress callback object that will be used by barcode detection
pargException	Pointer to exception structure that will be filled if an exception occurs