CBarcode_interface.h File Reference

Interface for CBarcode wrapper. More...

Go to the source code of this file.

Functions
CBarcode	CBarcode_Create (idrs_exception *pargException)
	Creates a new instance and initializes the internal values with default values.
CBarcode	CBarcode_Create2 (const idrs_string strValue, IDRS_UINT const uiConfidence, enum BarcodeType const evBarcodeType, IDRS_UINT const uiOrientation, const IDRS_RECT *rcBoundingBox, enum BarcodeEngineIdentifier const evEngineIdentifier, idrs_exception *pargException)
	Create a new instance and initializes the internal values with the provided values.
enum BarcodeType	CBarcode_GetBarcodeType (const CBarcode argCBarcode, idrs_exception *pargException)
	GetBarcodeType retrieves the barcode type.
const idrs_string	CBarcode_GetValue (const CBarcode argCBarcode, idrs_exception *pargException)
	GetValue retrieves the barcode value.
IDRS_UINT	CBarcode_GetOrientation (const CBarcode argCBarcode, idrs_exception *pargException)
	GetOrientation retrieves the barcode orientation.
IDRS_RECT	CBarcode_GetBoundingBox (const CBarcode argCBarcode, idrs_exception *pargException)
	GetBoundingBox retrieves the bounding box where the barcode can be found.
IDRS_UINT	CBarcode_GetConfidence (const CBarcode argCBarcode, idrs_exception *pargException)
	GetConfidence retrieves an indicator specifying how sure is the barcode engine about the detect barcode value.
enum BarcodeEngineIdentifier	CBarcode_GetEngineIdentifier (const CBarcode argCBarcode, idrs_exception *pargException)
	GetEngineIdentifier retrieves the identified of the barcode engine that detected the barcode.
void	CBarcode_SetBarcodeType (CBarcode argCBarcode, const enum BarcodeType *const evBarcodeType, idrs_exception *pargException)
	Sets the barcode type.
void	CBarcode_SetValue (CBarcode argCBarcode, const idrs_string strValue, idrs_exception *pargException)
	Sets the barcode value.
void	CBarcode_SetOrientation (CBarcode argCBarcode, IDRS_UINT const uiOrientation, idrs_exception *pargException)
	Sets the barcode orientation.
void	CBarcode_SetBoundingBox (CBarcode argCBarcode, const IDRS_RECT *rcBoundingBox, idrs_exception *pargException)
	Sets the bounding box where the barcode can be found.
void	CBarcode_SetConfidence (CBarcode argCBarcode, IDRS_UINT const uiConfidence, idrs_exception *pargException)
	Sets an indicator specifying how sure is the barcode engine about the detect barcode value.
void	CBarcode_SetEngineIdentifier (CBarcode argCBarcode, enum BarcodeEngineIdentifier const evEngineIdentifier, idrs_exception *pargException)
	Sets the identifier of the barcode engine that detected the barcode.
void	CBarcode_Destroy (CBarcode argCBarcode, idrs_exception *pargException)
	Destroys a CBarcode handle.
CBarcodeArray	ArrayInterface_Create_CBarcodeArray (idrs_exception *pargException)
	Creates a new CBarcodeArray object.

Detailed Description

Interface for CBarcode wrapper.

Function Documentation

ArrayInterface_Create_CBarcodeArray()

CBarcodeArray ArrayInterface_Create_CBarcodeArray

(

idrs_exception *

pargException

)

Creates a new CBarcodeArray object.

Parameters

pargException

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

Returns

The newly created CBarcodeArray

CBarcode_Create()

CBarcode CBarcode_Create

(

idrs_exception *

pargException

)

Creates a new instance and initializes the internal values with default values.

Parameters

pargException

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

CBarcode_Create2()

CBarcode CBarcode_Create2	(	const idrs_string	strValue,
		IDRS_UINT const	uiConfidence,
		enum BarcodeType const	evBarcodeType,
		IDRS_UINT const	uiOrientation,
		const IDRS_RECT *	rcBoundingBox,
		enum BarcodeEngineIdentifier const	evEngineIdentifier,
		idrs_exception *	pargException
	)

Create a new instance and initializes the internal values with the provided values.

Parameters

strValue	Barcode value
uiConfidence	Barcode confidence level
evBarcodeType	Barcode Type
uiOrientation	Barcode orientation
rcBoundingBox	Rectangle where the barcode is found in the page
evEngineIdentifier	Identifier of the barcode engine that detected the barcode
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcode_Destroy()

void CBarcode_Destroy	(	CBarcode	argCBarcode,
		idrs_exception *	pargException
	)

Destroys a CBarcode handle.

Parameters

argCBarcode	CBarcode handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcode_GetBarcodeType()

enum BarcodeType CBarcode_GetBarcodeType	(	const CBarcode	argCBarcode,
		idrs_exception *	pargException
	)

GetBarcodeType retrieves the barcode type.

Returns

Barcode type

Parameters

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

CBarcode_GetBoundingBox()

IDRS_RECT CBarcode_GetBoundingBox	(	const CBarcode	argCBarcode,
		idrs_exception *	pargException
	)

GetBoundingBox retrieves the bounding box where the barcode can be found.

Returns

Rectangle in the source image/page where the barcode was detected

Parameters

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

CBarcode_GetConfidence()

IDRS_UINT CBarcode_GetConfidence	(	const CBarcode	argCBarcode,
		idrs_exception *	pargException
	)

GetConfidence retrieves an indicator specifying how sure is the barcode engine about the detect barcode value.

The confidence level is a value ranging from 0 to 100, where 0 represents the least confidence and 100 represents the maximum confidence levels

Returns

IDRS::IDRS_UINT

Parameters

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

CBarcode_GetEngineIdentifier()

enum BarcodeEngineIdentifier CBarcode_GetEngineIdentifier	(	const CBarcode	argCBarcode,
		idrs_exception *	pargException
	)

GetEngineIdentifier retrieves the identified of the barcode engine that detected the barcode.

Returns

Barcode identifier of the engine that detected the barcode value

Parameters

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

CBarcode_GetOrientation()

IDRS_UINT CBarcode_GetOrientation	(	const CBarcode	argCBarcode,
		idrs_exception *	pargException
	)

GetOrientation retrieves the barcode orientation.

Returns

Barcode orientation

Parameters

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

CBarcode_GetValue()

const idrs_string CBarcode_GetValue	(	const CBarcode	argCBarcode,
		idrs_exception *	pargException
	)

GetValue retrieves the barcode value.

Returns

The barcode value

Parameters

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

CBarcode_SetBarcodeType()

void CBarcode_SetBarcodeType	(	CBarcode	argCBarcode,
		const enum BarcodeType *const	evBarcodeType,
		idrs_exception *	pargException
	)

Sets the barcode type.

Parameters

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

CBarcode_SetBoundingBox()

void CBarcode_SetBoundingBox	(	CBarcode	argCBarcode,
		const IDRS_RECT *	rcBoundingBox,
		idrs_exception *	pargException
	)

Sets the bounding box where the barcode can be found.

Parameters

argCBarcode	CBarcode handle
rcBoundingBox	Rectangle where the barcode is found in the page
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcode_SetConfidence()

void CBarcode_SetConfidence	(	CBarcode	argCBarcode,
		IDRS_UINT const	uiConfidence,
		idrs_exception *	pargException
	)

Sets an indicator specifying how sure is the barcode engine about the detect barcode value.

Parameters

argCBarcode	CBarcode handle
uiConfidence	Barcode confidence level
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcode_SetEngineIdentifier()

void CBarcode_SetEngineIdentifier	(	CBarcode	argCBarcode,
		enum BarcodeEngineIdentifier const	evEngineIdentifier,
		idrs_exception *	pargException
	)

Sets the identifier of the barcode engine that detected the barcode.

Parameters

argCBarcode	CBarcode handle
evEngineIdentifier	Identifier of the barcode engine that detected the barcode
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcode_SetOrientation()

void CBarcode_SetOrientation	(	CBarcode	argCBarcode,
		IDRS_UINT const	uiOrientation,
		idrs_exception *	pargException
	)

Sets the barcode orientation.

Parameters

argCBarcode	CBarcode handle
uiOrientation	The value to set
pargException	Pointer to exception structure that will be filled if an exception occurs

CBarcode_SetValue()

void CBarcode_SetValue	(	CBarcode	argCBarcode,
		const idrs_string	strValue,
		idrs_exception *	pargException
	)

Sets the barcode value.

Parameters

argCBarcode	CBarcode handle
strValue	The barcode value
pargException	Pointer to exception structure that will be filled if an exception occurs