CBarcodeParams_interface.h File Reference

Interface for CBarcodeParams wrapper. More...

Go to the source code of this file.

Functions
enum RecognitionType	CBarcodeParams_GetType (const CBarcodeParams argCBarcodeParams, idrs_exception *pargException)
	Gets the type of barcode detection - full page or zonal.
enum ThreadingMode	CBarcodeParams_GetThreadingMode (const CBarcodeParams argCBarcodeParams, idrs_exception *pargException)
	Gets the threading mode used for barcode detection.
void	CBarcodeParams_SetThreadingMode (CBarcodeParams argCBarcodeParams, enum ThreadingMode const evThreadingMode, idrs_exception *pargException)
	Sets the threading mode used for barcode detection.
enum Workdepth	CBarcodeParams_GetWorkdepth (const CBarcodeParams argCBarcodeParams, idrs_exception *pargException)
	Gets the work depth used for barcode detection.
void	CBarcodeParams_SetWorkdepth (CBarcodeParams argCBarcodeParams, enum Workdepth const evWorkdepth, idrs_exception *pargException)
	Sets the work depth used for barcode detection.
IDRS_BOOL	CBarcodeParams_GetRaiseEngineErrors (const CBarcodeParams argCBarcodeParams, idrs_exception *pargException)
	Gets the flag that indicates whether the barcode detection should raise an exception if an error occurrs in a barcode engine.
void	CBarcodeParams_SetRaiseEngineErrors (CBarcodeParams argCBarcodeParams, IDRS_BOOL const bRaiseEngineErrors, idrs_exception *pargException)
	Sets the flag that indicates whether the barcode detection should raise an exception if an error occurrs in a barcode engine.
CBarcodeEngineConfigArray	CBarcodeParams_GetEngineConfigs (const CBarcodeParams argCBarcodeParams, idrs_exception *pargException)
	Gets an array containing the barcode engine configurations. See.
void	CBarcodeParams_SetEngineConfigs (CBarcodeParams argCBarcodeParams, CBarcodeEngineConfigArray argxEngineConfigs, idrs_exception *pargException)
	Sets an array containing the barcode engine configurations. See.

Detailed Description

Interface for CBarcodeParams wrapper.

Function Documentation

CBarcodeParams_GetEngineConfigs()

CBarcodeEngineConfigArray CBarcodeParams_GetEngineConfigs	(	const CBarcodeParams	argCBarcodeParams,
		idrs_exception *	pargException
	)

Gets an array containing the barcode engine configurations. See.

See also

CBarcodeEngineConfig for engine configurations.

During barcode detection, there might be one or more barcode engines that are used. The barcode engine configuration plays an important role whether a barcode engine will be run or not.

The place in the barcode engine configuration will also set the barcode engine priorities. The barcode engine priority is an indirect setting that is taken into account during the following situations:

• sequential barcode engine execution, when threading mode is set to

  See also

  ThreadingMode::None. The barcode engines added first in the CBarcodeEngineConfigArray will be executed first.

• 2 or more barcode engines detect barcode(s) in the same place. The barcode that will be added to the results will be the one detected by the barcode engine with the highest priority (lower index in CBarcodeEngineConfigArray)

By default, all the available barcode engines will be enabled.

Returns

Array containing the barcode engine configurations.

Parameters

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

CBarcodeParams_GetRaiseEngineErrors()

IDRS_BOOL CBarcodeParams_GetRaiseEngineErrors	(	const CBarcodeParams	argCBarcodeParams,
		idrs_exception *	pargException
	)

Gets the flag that indicates whether the barcode detection should raise an exception if an error occurrs in a barcode engine.

During barcode processing it might happen that one or more engines will throw an exception. This setting determines the behavior of barcode processing code in such event. If the setting is IDRS_TRUE, then the barcode detection process will throw an exception as soon as a barcode engine has raised an error If the setting is IDRS_FALSE, then the barcode detection process will not throw an exception when a barcode engine raises an error and the barcode detection execution will continue.

By default, the setting is IDRS_FALSE

Returns

Boolean flag indicating whether the barcode detection should raise an exception when a barcode engine throwns an error.

Parameters

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

CBarcodeParams_GetThreadingMode()

enum ThreadingMode CBarcodeParams_GetThreadingMode	(	const CBarcodeParams	argCBarcodeParams,
		idrs_exception *	pargException
	)

Gets the threading mode used for barcode detection.

By default, the threading mode is set to

See also

ThreadingMode::Optimized

Returns

Threading mode used for barcode detection

Parameters

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

CBarcodeParams_GetType()

enum RecognitionType CBarcodeParams_GetType	(	const CBarcodeParams	argCBarcodeParams,
		idrs_exception *	pargException
	)

Gets the type of barcode detection - full page or zonal.

The barcode detection is initialized automatically by the type of the instantiated object:

See also

CBarcodePageParams or

CBarcodeZonalParams

Returns

Barcode detection type

Parameters

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

CBarcodeParams_GetWorkdepth()

enum Workdepth CBarcodeParams_GetWorkdepth	(	const CBarcodeParams	argCBarcodeParams,
		idrs_exception *	pargException
	)

Gets the work depth used for barcode detection.

The work depth indicates how much time/processing the barcode engines can spend for barcode detection. See

See also

Workdepth for more details

By default, the work depth is set to

See also

Workdepth::Balanced

Returns

Work depth used for barcode detection

Parameters

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

CBarcodeParams_SetEngineConfigs()

void CBarcodeParams_SetEngineConfigs	(	CBarcodeParams	argCBarcodeParams,
		CBarcodeEngineConfigArray	argxEngineConfigs,
		idrs_exception *	pargException
	)

Sets an array containing the barcode engine configurations. See.

See also

CBarcodeEngineConfig for engine configurations.

During barcode detection, there might be one or more barcode engines that are used. The barcode engine configuration plays an important role whether a barcode engine will be run or not.

The place in the barcode engine configuration will also set the barcode engine priorities. The barcode engine priority is an indirect setting that is taken into account during the following situations:

• sequential barcode engine execution, when threading mode is set to

  See also

  ThreadingMode::None. The barcode engines added first in the CBarcodeEngineConfigArray will be executed first.

• 2 or more barcode engines detect barcode(s) in the same place. The barcode that will be added to the results will be the one detected by the barcode engine with the highest priority (lower index in CBarcodeEngineConfigArray)

By default, all the available barcode engines will be enabled.

Parameters

argCBarcodeParams	CBarcodeParams handle
argxEngineConfigs	Array containing the barcode engine configurations.
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeParams_SetRaiseEngineErrors()

void CBarcodeParams_SetRaiseEngineErrors	(	CBarcodeParams	argCBarcodeParams,
		IDRS_BOOL const	bRaiseEngineErrors,
		idrs_exception *	pargException
	)

Sets the flag that indicates whether the barcode detection should raise an exception if an error occurrs in a barcode engine.

During barcode processing it might happen that one or more engines will throw an exception. This setting determines the behavior of barcode processing code in such event. If the setting is IDRS_TRUE, then the barcode detection process will throw an exception as soon as a barcode engine has raised an error If the setting is IDRS_FALSE, then the barcode detection process will not throw an exception when a barcode engine raises an error and the barcode detection execution will continue.

By default, the setting is IDRS_FALSE

Parameters

argCBarcodeParams	CBarcodeParams handle
bRaiseEngineErrors	Boolean flag indicating whether the barcode detection should raise an exception when a barcode engine throwns an error.
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeParams_SetThreadingMode()

void CBarcodeParams_SetThreadingMode	(	CBarcodeParams	argCBarcodeParams,
		enum ThreadingMode const	evThreadingMode,
		idrs_exception *	pargException
	)

Sets the threading mode used for barcode detection.

By default, the threading mode is set to

See also

ThreadingMode::Optimized

Parameters

argCBarcodeParams	CBarcodeParams handle
evThreadingMode	Threading mode to set
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcodeParams_SetWorkdepth()

void CBarcodeParams_SetWorkdepth	(	CBarcodeParams	argCBarcodeParams,
		enum Workdepth const	evWorkdepth,
		idrs_exception *	pargException
	)

Sets the work depth used for barcode detection.

The work depth indicates how much time/processing the barcode engines can spend for barcode detection. See

See also

Workdepth for more details

By default, the work depth is set to

See also

Workdepth::Balanced

Parameters

argCBarcodeParams	CBarcodeParams handle
evWorkdepth	Work depth to be used for barcode detection
pargException	Pointer to exception structure that will be filled if an exception occurs