COcrZoneDescription_interface.h File Reference

Interface for COcrZoneDescription wrapper. More...

Go to the source code of this file.

Functions
COcrZoneDescription	COcrZoneDescription_Create (idrs_exception *pargException)
	Creates a new instance of this class and initializes the created object with the default values:
COcrZoneDescription	COcrZoneDescription_Create2 (enum ZoneType const evZoneType, const IDRS_RECT *rcZone, idrs_exception *pargException)
	Creates a new instance of this class and initializes the created object with the provided arguments.
COcrZoneDescription	COcrZoneDescription_Create3 (enum ZoneType const evZoneType, const CPolygon argPolygon, idrs_exception *pargException)
	Creates a new instance of this class and initializes the created object with the provided arguments.
enum ZoneType	COcrZoneDescription_GetType (const COcrZoneDescription argCOcrZoneDescription, idrs_exception *pargException)
	Gets the zone type.
void	COcrZoneDescription_SetType (COcrZoneDescription argCOcrZoneDescription, enum ZoneType const evZoneType, idrs_exception *pargException)
	Sets the zone type.
CPolygon	COcrZoneDescription_GetZone (const COcrZoneDescription argCOcrZoneDescription, idrs_exception *pargException)
	Gets the polygon defining the coordinates of the zone where text recognition will be executed.
void	COcrZoneDescription_SetZone (COcrZoneDescription argCOcrZoneDescription, const CPolygon argZone, idrs_exception *pargException)
	Sets the polygon defining the coordinates of the zone where text recognition will be executed.
void	COcrZoneDescription_SetIdentifier (COcrZoneDescription argCOcrZoneDescription, const idrs_string strZoneIdentifier, idrs_exception *pargException)
	Sets a unique identifier to the zone.
idrs_string	COcrZoneDescription_GetIdentifier (const COcrZoneDescription argCOcrZoneDescription, idrs_exception *pargException)
	Gets the zone identifier.
void	COcrZoneDescription_Destroy (COcrZoneDescription argCOcrZoneDescription, idrs_exception *pargException)
	Destroys a COcrZoneDescription handle.
COcrZoneDescriptionArray	ArrayInterface_Create_COcrZoneDescriptionArray (idrs_exception *pargException)
	Creates a new COcrZoneDescriptionArray object.

Detailed Description

Interface for COcrZoneDescription wrapper.

Function Documentation

ArrayInterface_Create_COcrZoneDescriptionArray()

COcrZoneDescriptionArray ArrayInterface_Create_COcrZoneDescriptionArray

(

idrs_exception *

pargException

)

Creates a new COcrZoneDescriptionArray object.

Parameters

pargException

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

Returns

The newly created COcrZoneDescriptionArray

COcrZoneDescription_Create()

COcrZoneDescription COcrZoneDescription_Create

(

idrs_exception *

pargException

)

Creates a new instance of this class and initializes the created object with the default values:

• zone type will be set to

  See also

  TextType::Text

• polygon will be set to NULL

  Parameters

  pargException

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

COcrZoneDescription_Create2()

COcrZoneDescription COcrZoneDescription_Create2	(	enum ZoneType const	evZoneType,
		const IDRS_RECT *	rcZone,
		idrs_exception *	pargException
	)

Creates a new instance of this class and initializes the created object with the provided arguments.

Parameters

evZoneType	Zone type
rcZone	Rectangle defining the zone where the text recognition will be run
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrZoneDescription_Create3()

COcrZoneDescription COcrZoneDescription_Create3	(	enum ZoneType const	evZoneType,
		const CPolygon	argPolygon,
		idrs_exception *	pargException
	)

Creates a new instance of this class and initializes the created object with the provided arguments.

Parameters

evZoneType	Zone type
argPolygon	Polygon defining the zone where the text recognition will be run
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrZoneDescription_Destroy()

void COcrZoneDescription_Destroy	(	COcrZoneDescription	argCOcrZoneDescription,
		idrs_exception *	pargException
	)

Destroys a COcrZoneDescription handle.

Parameters

argCOcrZoneDescription	COcrZoneDescription handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrZoneDescription_GetIdentifier()

idrs_string COcrZoneDescription_GetIdentifier	(	const COcrZoneDescription	argCOcrZoneDescription,
		idrs_exception *	pargException
	)

Gets the zone identifier.

If an identifier was previously assigned using SetIdentifier, it will be returned. Otherwise, a system-generated identifier will be provided.

Returns

The identifier associated with the zone.

Parameters

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

COcrZoneDescription_GetType()

enum ZoneType COcrZoneDescription_GetType	(	const COcrZoneDescription	argCOcrZoneDescription,
		idrs_exception *	pargException
	)

Gets the zone type.

Returns

Zone type expected during text recognition

Parameters

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

COcrZoneDescription_GetZone()

CPolygon COcrZoneDescription_GetZone	(	const COcrZoneDescription	argCOcrZoneDescription,
		idrs_exception *	pargException
	)

Gets the polygon defining the coordinates of the zone where text recognition will be executed.

Setting one or more coordinates outside the page/image bounds will trigger an exception during text recognition execution

Returns

Polygon object defining the coordinates of the zone where text recognition will be executed.

Parameters

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

COcrZoneDescription_SetIdentifier()

void COcrZoneDescription_SetIdentifier	(	COcrZoneDescription	argCOcrZoneDescription,
		const idrs_string	strZoneIdentifier,
		idrs_exception *	pargException
	)

Sets a unique identifier to the zone.

This identifier is used to reference the zone containing recognized content after the OCR process is completed.

If no identifier is explicitly assigned via this method, a unique identifier will be automatically generated.

Parameters

argCOcrZoneDescription	COcrZoneDescription handle
strZoneIdentifier	The user-defined identifier for the zone.
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrZoneDescription_SetType()

void COcrZoneDescription_SetType	(	COcrZoneDescription	argCOcrZoneDescription,
		enum ZoneType const	evZoneType,
		idrs_exception *	pargException
	)

Sets the zone type.

Parameters

argCOcrZoneDescription	COcrZoneDescription handle
evZoneType	Zone type expected during text recognition
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrZoneDescription_SetZone()

void COcrZoneDescription_SetZone	(	COcrZoneDescription	argCOcrZoneDescription,
		const CPolygon	argZone,
		idrs_exception *	pargException
	)

Sets the polygon defining the coordinates of the zone where text recognition will be executed.

Setting one or more coordinates outside the page/image bounds will trigger an exception during text recognition execution

Parameters

argCOcrZoneDescription	COcrZoneDescription handle
argZone	Polygon object defining the coordinates of the zone where text recognition will be executed.
pargException	Pointer to exception structure that will be filled if an exception occurs