CBarcodeValidationCriteria_interface.h File Reference

Interface for CBarcodeValidationCriteria wrapper. More...

Go to the source code of this file.

Functions
CBarcodeValidationCriteria	CBarcodeValidationCriteria_Create (enum BarcodeType const evBarcodeType, IDRS_BOOL const bEnabled, idrs_exception *pargException)
	Creates a new instance of this class and associates the provided.
CBarcodeValidationCriteria	CBarcodeValidationCriteria_Create2 (enum BarcodeType const evBarcodeType, idrs_exception *pargException)
	Creates a new instance of this class and associates the provided.
enum BarcodeType	CBarcodeValidationCriteria_GetBarcodeType (const CBarcodeValidationCriteria argCBarcodeValidationCriteria, idrs_exception *pargException)
	Gets the barcode barcode type associated to this criteria.
IDRS_BOOL	CBarcodeValidationCriteria_GetEnabled (const CBarcodeValidationCriteria argCBarcodeValidationCriteria, idrs_exception *pargException)
	Gets the boolean flag that specifies if the associated barcode barcode type is enabled or not.
void	CBarcodeValidationCriteria_SetEnabled (CBarcodeValidationCriteria argCBarcodeValidationCriteria, IDRS_BOOL const bEnabled, idrs_exception *pargException)
	Sets the boolean flag that specifies if the associated barcode barcode type is enabled or not.
IDRS_UINT	CBarcodeValidationCriteria_GetMinimumConfidence (CBarcodeValidationCriteria argCBarcodeValidationCriteria, idrs_exception *pargException)
	Gets the minimum confidence level for which a detected result of the associated barcode type is considered valid. If the confidence level does not match the match this setting, the barcode result will be rejected.
void	CBarcodeValidationCriteria_SetMinimumConfidence (CBarcodeValidationCriteria argCBarcodeValidationCriteria, IDRS_UINT const uiMinimumConfidence, idrs_exception *pargException)
	Sets the minimum confidence level for which a detected result of the associated barcode type is considered valid. If the confidence level does not match the match this setting, the barcode result will be rejected.
void	CBarcodeValidationCriteria_Destroy (CBarcodeValidationCriteria argCBarcodeValidationCriteria, idrs_exception *pargException)
	Destroys a CBarcodeValidationCriteria handle.
CBarcodeValidationCriteriaArray	ArrayInterface_Create_CBarcodeValidationCriteriaArray (idrs_exception *pargException)
	Creates a new CBarcodeValidationCriteriaArray object.

Detailed Description

Interface for CBarcodeValidationCriteria wrapper.

Function Documentation

ArrayInterface_Create_CBarcodeValidationCriteriaArray()

CBarcodeValidationCriteriaArray ArrayInterface_Create_CBarcodeValidationCriteriaArray

(

idrs_exception *

pargException

)

Creates a new CBarcodeValidationCriteriaArray object.

Parameters

pargException

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

Returns

The newly created CBarcodeValidationCriteriaArray

CBarcodeValidationCriteria_Create()

CBarcodeValidationCriteria CBarcodeValidationCriteria_Create	(	enum BarcodeType const	evBarcodeType,
		IDRS_BOOL const	bEnabled,
		idrs_exception *	pargException
	)

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

See also

BarcodeType to it.

Parameters

evBarcodeType	Barcode type
bEnabled	Boolean flag specifying whether the barcode type is enabled or not.
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeValidationCriteria_Create2()

CBarcodeValidationCriteria CBarcodeValidationCriteria_Create2	(	enum BarcodeType const	evBarcodeType,
		idrs_exception *	pargException
	)

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

See also

BarcodeType to it.

Parameters

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

CBarcodeValidationCriteria_Destroy()

void CBarcodeValidationCriteria_Destroy	(	CBarcodeValidationCriteria	argCBarcodeValidationCriteria,
		idrs_exception *	pargException
	)

Destroys a CBarcodeValidationCriteria handle.

Parameters

argCBarcodeValidationCriteria	CBarcodeValidationCriteria handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeValidationCriteria_GetBarcodeType()

enum BarcodeType CBarcodeValidationCriteria_GetBarcodeType	(	const CBarcodeValidationCriteria	argCBarcodeValidationCriteria,
		idrs_exception *	pargException
	)

Gets the barcode barcode type associated to this criteria.

Barcode criteria validation works per barcode type

Returns

Barcode type

Parameters

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

CBarcodeValidationCriteria_GetEnabled()

IDRS_BOOL CBarcodeValidationCriteria_GetEnabled	(	const CBarcodeValidationCriteria	argCBarcodeValidationCriteria,
		idrs_exception *	pargException
	)

Gets the boolean flag that specifies if the associated barcode barcode type is enabled or not.

Since the barcode validation criteria are set for each engine separately, this setting has an effect on the barcode engine for which the barcode validation criteria is assigned.

Returns

Boolean flag enabling/disabling the associated barcode type

Parameters

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

CBarcodeValidationCriteria_GetMinimumConfidence()

IDRS_UINT CBarcodeValidationCriteria_GetMinimumConfidence	(	CBarcodeValidationCriteria	argCBarcodeValidationCriteria,
		idrs_exception *	pargException
	)

Gets the minimum confidence level for which a detected result of the associated barcode type is considered valid. If the confidence level does not match the match this setting, the barcode result will be rejected.

Since the barcode validation criteria are set for each engine separately, this setting has an effect on the barcode engine for which the barcode validation criteria is assigned.

Returns

Minimum confidence level for the specified barcode type

Parameters

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

CBarcodeValidationCriteria_SetEnabled()

void CBarcodeValidationCriteria_SetEnabled	(	CBarcodeValidationCriteria	argCBarcodeValidationCriteria,
		IDRS_BOOL const	bEnabled,
		idrs_exception *	pargException
	)

Sets the boolean flag that specifies if the associated barcode barcode type is enabled or not.

Since the barcode validation criteria are set for each engine separately, this setting has an effect on the barcode engine for which the barcode validation criteria is assigned.

Parameters

argCBarcodeValidationCriteria	CBarcodeValidationCriteria handle
bEnabled	Boolean flag enabling/disabling the associated barcode type
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeValidationCriteria_SetMinimumConfidence()

void CBarcodeValidationCriteria_SetMinimumConfidence	(	CBarcodeValidationCriteria	argCBarcodeValidationCriteria,
		IDRS_UINT const	uiMinimumConfidence,
		idrs_exception *	pargException
	)

Sets the minimum confidence level for which a detected result of the associated barcode type is considered valid. If the confidence level does not match the match this setting, the barcode result will be rejected.

Since the barcode validation criteria are set for each engine separately, this setting has an effect on the barcode engine for which the barcode validation criteria is assigned.

Parameters

argCBarcodeValidationCriteria	CBarcodeValidationCriteria handle
uiMinimumConfidence	Minimum confidence level for the specified barcode type
pargException	Pointer to exception structure that will be filled if an exception occurs