Interface for CBarcodeContext wrapper. More...

Functions
CBarcodeContext	CBarcodeContext_Create (idrs_exception *pargException)
	Create creates a barcode recognition context. The context is initialized to detect all recommended barcode types allowed by the licenses, apart from QrCode, Aztec and Datamatrix types which are not enabled by default.

CBarcodeContext	CBarcodeContext_Create2 (enum BarcodeType const evBarcodeType, idrs_exception *pargException)
	Create creates a barcode recognition context to recognize the given barcode type.

CBarcodeContext	CBarcodeContext_Create3 (const BarcodeTypeArray xBarcodeTypes, idrs_exception *pargException)
	Create creates a barcode recognition context to recognize the given barcode types.

void	CBarcodeContext_SetBarcodeTypes (CBarcodeContext argCBarcodeContext, const BarcodeTypeArray xBarcodeTypes, idrs_exception *pargException)
	SetBarcodeTypes sets the barcode types to look for.

BarcodeTypeArray	CBarcodeContext_GetBarcodeTypes (const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
	Gets the barcode types set.

IDRS_UINT	CBarcodeContext_GetMinimumPixelsHeight (const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
	Get the minimum bar height required to validate a 1D barcode candidate.

void	CBarcodeContext_SetMinimumPixelsHeight (CBarcodeContext argCBarcodeContext, IDRS_UINT const uiMinimumPixelsHeight, idrs_exception *pargException)
	Set the minimum bar height required to validate a 1D barcode candidate.

IDRS_UINT	CBarcodeContext_GetMaximumPixelsHeight (const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
	Get the maximum bar height required to validate a 1D barcode candidate.

void	CBarcodeContext_SetMaximumPixelsHeight (CBarcodeContext argCBarcodeContext, IDRS_UINT const uiMaximumPixelsHeight, idrs_exception *pargException)
	Set the maximum bar height required to validate a 1D barcode candidate.

IDRS_UINT	CBarcodeContext_GetMinimumSymbolsLength (const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
	Get the minimum number of symbols required to validate a 1D barcode candidate.

void	CBarcodeContext_SetMinimumSymbolsLength (CBarcodeContext argCBarcodeContext, IDRS_UINT const uiMinimumSymbolsLength, idrs_exception *pargException)
	Set the minimum number of symbols required to validate a 1D barcode candidate.

IDRS_UINT	CBarcodeContext_GetMaximumSymbolsLength (const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
	Get the maximum number of symbols required to validate a 1D barcode candidate.

void	CBarcodeContext_SetMaximumSymbolsLength (CBarcodeContext argCBarcodeContext, IDRS_UINT const uiMaximumSymbolsLength, idrs_exception *pargException)
	Set the maximum number of symbols required to validate a 1D barcode candidate.

BarcodeEncodingArray	CBarcodeContext_GetDetectedEncodings (const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
	Get the array of barcode encodings to detect.

void	CBarcodeContext_SetDetectedEncodings (CBarcodeContext argCBarcodeContext, const BarcodeEncodingArray argBarcodeEncodingArray, idrs_exception *pargException)
	Set the array of barcode encodings to detect.

IDRS_BOOL	CBarcodeContext_GetStopOnFirstResult (const CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
	Get the flag indicating if the iDRS should stop barcode recognition as soon as a result is found.

void	CBarcodeContext_SetStopOnFirstResult (CBarcodeContext argCBarcodeContext, IDRS_BOOL const bStopOnFirstResult, idrs_exception *pargException)
	Set the flag indicating if the iDRS should stop barcode recognition as soon as a result is found.

BarcodeTypeArray	CBarcodeContext_GetRecommendedBarcodeTypes (idrs_exception *pargException)
	Gets a CBarcodeSet object populated with the barcode types recommended for most barcode recognition workflows.

void	CBarcodeContext_Destroy (CBarcodeContext argCBarcodeContext, idrs_exception *pargException)
	Destroys a CBarcodeContext handle.

Detailed Description

Interface for CBarcodeContext wrapper.

Function Documentation

◆ CBarcodeContext_Create()

CBarcodeContext CBarcodeContext_Create ( idrs_exception * pargException )

Create creates a barcode recognition context. The context is initialized to detect all recommended barcode types allowed by the licenses, apart from QrCode, Aztec and Datamatrix types which are not enabled by default.

Parameters

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

◆ CBarcodeContext_Create2()

CBarcodeContext CBarcodeContext_Create2	(	enum BarcodeType const	evBarcodeType,
		idrs_exception *	pargException
	)

Create creates a barcode recognition context to recognize the given barcode type.

Parameters

evBarcodeType	The barcode type to recognize.
pargException	Pointer to exception structure that will be filled if an exception occurs

See also: group_idrs_barcodes iDRS barcode types.

Note: If the provided value is BarcodeType::None, all recommended barcode types allowed by the licenses, apart from QrCode, Aztec and Datamatrix types which are not enabled by default.

◆ CBarcodeContext_Create3()

CBarcodeContext CBarcodeContext_Create3	(	const BarcodeTypeArray	xBarcodeTypes,
		idrs_exception *	pargException
	)

Create creates a barcode recognition context to recognize the given barcode types.

Parameters

xBarcodeTypes	An array containing the barcode types to recognize.
pargException	Pointer to exception structure that will be filled if an exception occurs

See also: group_idrs_barcodes iDRS barcode types.

◆ CBarcodeContext_Destroy()

void CBarcodeContext_Destroy	(	CBarcodeContext	argCBarcodeContext,
		idrs_exception *	pargException
	)

Destroys a CBarcodeContext handle.

Parameters

argCBarcodeContext	CBarcodeContext handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CBarcodeContext_GetBarcodeTypes()

BarcodeTypeArray CBarcodeContext_GetBarcodeTypes	(	const CBarcodeContext	argCBarcodeContext,
		idrs_exception *	pargException
	)

Gets the barcode types set.

Returns: The array of barcode types to be used for recognition

Parameters

argCBarcodeContext	CBarcodeContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CBarcodeContext_GetDetectedEncodings()

BarcodeEncodingArray CBarcodeContext_GetDetectedEncodings	(	const CBarcodeContext	argCBarcodeContext,
		idrs_exception *	pargException
	)

Get the array of barcode encodings to detect.

Returns: The array of barcode encodings

Parameters

argCBarcodeContext	CBarcodeContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CBarcodeContext_GetMaximumPixelsHeight()

IDRS_UINT CBarcodeContext_GetMaximumPixelsHeight	(	const CBarcodeContext	argCBarcodeContext,
		idrs_exception *	pargException
	)

Get the maximum bar height required to validate a 1D barcode candidate.

Returns: The maximum bar height

Parameters

argCBarcodeContext	CBarcodeContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CBarcodeContext_GetMaximumSymbolsLength()

IDRS_UINT CBarcodeContext_GetMaximumSymbolsLength	(	const CBarcodeContext	argCBarcodeContext,
		idrs_exception *	pargException
	)

Get the maximum number of symbols required to validate a 1D barcode candidate.

Returns: The maximum symbols number

Parameters

argCBarcodeContext	CBarcodeContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CBarcodeContext_GetMinimumPixelsHeight()

IDRS_UINT CBarcodeContext_GetMinimumPixelsHeight	(	const CBarcodeContext	argCBarcodeContext,
		idrs_exception *	pargException
	)

Get the minimum bar height required to validate a 1D barcode candidate.

Returns: The minimum bar height

Parameters

argCBarcodeContext	CBarcodeContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CBarcodeContext_GetMinimumSymbolsLength()

IDRS_UINT CBarcodeContext_GetMinimumSymbolsLength	(	const CBarcodeContext	argCBarcodeContext,
		idrs_exception *	pargException
	)

Get the minimum number of symbols required to validate a 1D barcode candidate.

Returns: The minimum symbols number

Parameters

argCBarcodeContext	CBarcodeContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CBarcodeContext_GetRecommendedBarcodeTypes()

BarcodeTypeArray CBarcodeContext_GetRecommendedBarcodeTypes ( idrs_exception * pargException )

Gets a CBarcodeSet object populated with the barcode types recommended for most barcode recognition workflows.

PDF417, QRCode and Aztec barcodes will be added automatically if the required extensions are enabled.
Datamatrix barcode type will not be enabled by default, even if the corresponding extension is set, it needs to be activated explicitly.
For other barcode types, they can be activated provided they are a valid type.

Returns: The set of recommended barcode types.

Parameters

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

◆ CBarcodeContext_GetStopOnFirstResult()

IDRS_BOOL CBarcodeContext_GetStopOnFirstResult	(	const CBarcodeContext	argCBarcodeContext,
		idrs_exception *	pargException
	)

Get the flag indicating if the iDRS should stop barcode recognition as soon as a result is found.

Returns: The value of the flag

Parameters

argCBarcodeContext	CBarcodeContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CBarcodeContext_SetBarcodeTypes()

void CBarcodeContext_SetBarcodeTypes	(	CBarcodeContext	argCBarcodeContext,
		const BarcodeTypeArray	xBarcodeTypes,
		idrs_exception *	pargException
	)

SetBarcodeTypes sets the barcode types to look for.

Parameters

argCBarcodeContext	CBarcodeContext handle
xBarcodeTypes	An array containing the barcode types to recognize.
pargException	Pointer to exception structure that will be filled if an exception occurs

See also: group_idrs_barcodes iDRS barcode types.

◆ CBarcodeContext_SetDetectedEncodings()

void CBarcodeContext_SetDetectedEncodings	(	CBarcodeContext	argCBarcodeContext,
		const BarcodeEncodingArray	argBarcodeEncodingArray,
		idrs_exception *	pargException
	)

Set the array of barcode encodings to detect.

argBarcodeEncodingArray The array of barcode encodings to detect

Parameters

argCBarcodeContext	CBarcodeContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CBarcodeContext_SetMaximumPixelsHeight()

void CBarcodeContext_SetMaximumPixelsHeight	(	CBarcodeContext	argCBarcodeContext,
		IDRS_UINT const	uiMaximumPixelsHeight,
		idrs_exception *	pargException
	)

Set the maximum bar height required to validate a 1D barcode candidate.

Parameters

argCBarcodeContext	CBarcodeContext handle
uiMaximumPixelsHeight	The value to set
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CBarcodeContext_SetMaximumSymbolsLength()

void CBarcodeContext_SetMaximumSymbolsLength	(	CBarcodeContext	argCBarcodeContext,
		IDRS_UINT const	uiMaximumSymbolsLength,
		idrs_exception *	pargException
	)

Set the maximum number of symbols required to validate a 1D barcode candidate.

Parameters

argCBarcodeContext	CBarcodeContext handle
uiMaximumSymbolsLength	The value to set
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CBarcodeContext_SetMinimumPixelsHeight()

void CBarcodeContext_SetMinimumPixelsHeight	(	CBarcodeContext	argCBarcodeContext,
		IDRS_UINT const	uiMinimumPixelsHeight,
		idrs_exception *	pargException
	)

Set the minimum bar height required to validate a 1D barcode candidate.

Parameters

argCBarcodeContext	CBarcodeContext handle
uiMinimumPixelsHeight	The value to set
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CBarcodeContext_SetMinimumSymbolsLength()

void CBarcodeContext_SetMinimumSymbolsLength	(	CBarcodeContext	argCBarcodeContext,
		IDRS_UINT const	uiMinimumSymbolsLength,
		idrs_exception *	pargException
	)

Set the minimum number of symbols required to validate a 1D barcode candidate.

Parameters

argCBarcodeContext	CBarcodeContext handle
uiMinimumSymbolsLength	The value to set
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CBarcodeContext_SetStopOnFirstResult()

void CBarcodeContext_SetStopOnFirstResult	(	CBarcodeContext	argCBarcodeContext,
		IDRS_BOOL const	bStopOnFirstResult,
		idrs_exception *	pargException
	)

Set the flag indicating if the iDRS should stop barcode recognition as soon as a result is found.

Parameters

argCBarcodeContext	CBarcodeContext handle
pargException	Pointer to exception structure that will be filled if an exception occurs

Functions

Detailed Description

Function Documentation

◆ CBarcodeContext_Create()

◆ CBarcodeContext_Create2()

◆ CBarcodeContext_Create3()

◆ CBarcodeContext_Destroy()

◆ CBarcodeContext_GetBarcodeTypes()

◆ CBarcodeContext_GetDetectedEncodings()

◆ CBarcodeContext_GetMaximumPixelsHeight()

◆ CBarcodeContext_GetMaximumSymbolsLength()

◆ CBarcodeContext_GetMinimumPixelsHeight()

◆ CBarcodeContext_GetMinimumSymbolsLength()

◆ CBarcodeContext_GetRecommendedBarcodeTypes()

◆ CBarcodeContext_GetStopOnFirstResult()

◆ CBarcodeContext_SetBarcodeTypes()

◆ CBarcodeContext_SetDetectedEncodings()

◆ CBarcodeContext_SetMaximumPixelsHeight()

◆ CBarcodeContext_SetMaximumSymbolsLength()

◆ CBarcodeContext_SetMinimumPixelsHeight()

◆ CBarcodeContext_SetMinimumSymbolsLength()

◆ CBarcodeContext_SetStopOnFirstResult()