CBarcodeEngineManager_interface.h File Reference

Interface for CBarcodeEngineManager wrapper. More...

Go to the source code of this file.

Functions
IDRS_ERROR	CBarcodeEngineManager_RegisterBarcodeEngine (const IBarcodeEngine argBarcodeEngine, idrs_exception *pargException)
	RegisterBarcodeEngine adds a barcode engine to the barcode engines available for recognition.
IDRS_ERROR	CBarcodeEngineManager_UnregisterBarcodeEngine (enum BarcodeEngineIdentifier const evBarcodeUID, idrs_exception *pargException)
	UnregisterBarcodeEngine removes a barcode engine from the barcode engines available for recognition.
IDRS_UINT	CBarcodeEngineManager_GetBarcodeEngineCount (idrs_exception *pargException)
	Returns the number of barcode engines currently registered.
IBarcodeEngine	CBarcodeEngineManager_GetAt (IDRS_UINT const uiIndex, idrs_exception *pargException)
	GetAt returns a pointer to a barcode engine already added.
IDRS_BOOL	CBarcodeEngineManager_IsBarcodeEngineRegistered (enum BarcodeEngineIdentifier const evBarcodeUID, idrs_exception *pargException)
	IsBarcodeEngineRegistered verifies if a specified barcode engine identifier is registered or not.
IBarcodeEngine	CBarcodeEngineManager_GetEngineByUniqueIdentifier (enum BarcodeEngineIdentifier const evBarcodeUID, idrs_exception *pargException)
	GetEngineByUniqueIdentifier retrieves a barcode engine by it's unique identifier.

Detailed Description

Interface for CBarcodeEngineManager wrapper.

Function Documentation

CBarcodeEngineManager_GetAt()

IBarcodeEngine CBarcodeEngineManager_GetAt	(	IDRS_UINT const	uiIndex,
		idrs_exception *	pargException
	)

GetAt returns a pointer to a barcode engine already added.

Parameters

uiIndex	Index of the barcode engine to be returned
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

Pointer to the barcode engine stored at specified index

CBarcodeEngineManager_GetBarcodeEngineCount()

IDRS_UINT CBarcodeEngineManager_GetBarcodeEngineCount

(

idrs_exception *

pargException

)

Returns the number of barcode engines currently registered.

Please note that iDRS barcode engines are also included in the count returned.

Returns

The number of barcode engines already added

Parameters

pargException

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

CBarcodeEngineManager_GetEngineByUniqueIdentifier()

IBarcodeEngine CBarcodeEngineManager_GetEngineByUniqueIdentifier	(	enum BarcodeEngineIdentifier const	evBarcodeUID,
		idrs_exception *	pargException
	)

GetEngineByUniqueIdentifier retrieves a barcode engine by it's unique identifier.

If there is no barcode engine having the supplied identifier, the function will return NULL

Parameters

evBarcodeUID	Barcode engine unique identifier
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

Pointer to the barcode engine if it has been found, NULL otherwise

CBarcodeEngineManager_IsBarcodeEngineRegistered()

IDRS_BOOL CBarcodeEngineManager_IsBarcodeEngineRegistered	(	enum BarcodeEngineIdentifier const	evBarcodeUID,
		idrs_exception *	pargException
	)

IsBarcodeEngineRegistered verifies if a specified barcode engine identifier is registered or not.

Parameters

evBarcodeUID	Barcode engine unique identifier
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

IDRS_TRUE if the barcode engine has been found, IDRS_FALSE otherwise

CBarcodeEngineManager_RegisterBarcodeEngine()

IDRS_ERROR CBarcodeEngineManager_RegisterBarcodeEngine	(	const IBarcodeEngine	argBarcodeEngine,
		idrs_exception *	pargException
	)

RegisterBarcodeEngine adds a barcode engine to the barcode engines available for recognition.

Please note that the barcode engine is added by reference. iDRS SDK will store the pointers internally. It is integrator's responsability to ensure that the reference stays valid until the barcode engine is unregistered from the CBarcodeEngineManager

Parameters

argBarcodeEngine	Reference to the barcode engine object to register
pargException	Pointer to exception structure that will be filled if an exception occurs

Return values

IDRS_SUCCESS	if the barcode engine was successfully registered
IDRS_ERROR_BARCODE_ENGINE_ALREADY_REGISTERED	if the barcode engine is already registered

CBarcodeEngineManager_UnregisterBarcodeEngine()

IDRS_ERROR CBarcodeEngineManager_UnregisterBarcodeEngine	(	enum BarcodeEngineIdentifier const	evBarcodeUID,
		idrs_exception *	pargException
	)

UnregisterBarcodeEngine removes a barcode engine from the barcode engines available for recognition.

Please note that iDRS SDK will not try to delete or cleanup the removed object. It is integrator's responsability to cleanup any memory used by the barcode engine.

Once unregistered, the concerned engine won't be taken into consideration anymore for barcode recognition.

Please note that iDRS SDK internal barcode engines cannot be removed from the registry. If you do not want to use a specific engine, you can instead disable it. See

See also

CBarcodeContext for details

Parameters

evBarcodeUID	Barcode engine unique identifier
pargException	Pointer to exception structure that will be filled if an exception occurs

Return values

IDRS_SUCCESS

if the barcode engine was successfully unregistered, another error code otherwise