COcrZonalSettings_interface.h File Reference

Interface for COcrZonalSettings wrapper. More...

Go to the source code of this file.

Functions
COcrZonalSettings	COcrZonalSettings_Create (idrs_exception *pargException)
	Creates a new instance of this class.
COcrContext	COcrZonalSettings_GetContext (const COcrZonalSettings argCOcrZonalSettings, idrs_exception *pargException)
	Gets the associated ocr context.
void	COcrZonalSettings_SetContext (COcrZonalSettings argCOcrZonalSettings, const COcrContext argContext, idrs_exception *pargException)
	Sets the associated ocr context.
COcrZoneDescriptionArray	COcrZonalSettings_GetZones (const COcrZonalSettings argCOcrZonalSettings, idrs_exception *pargException)
	Gets the array of zones where text recognition will be executed using the associated context.
void	COcrZonalSettings_SetZones (COcrZonalSettings argCOcrZonalSettings, const COcrZoneDescriptionArray argxZones, idrs_exception *pargException)
	Sets the array of zones where text recognition will be executed using the associated context.
void	COcrZonalSettings_Destroy (COcrZonalSettings argCOcrZonalSettings, idrs_exception *pargException)
	Destroys a COcrZonalSettings handle.
COcrZonalSettingsArray	ArrayInterface_Create_COcrZonalSettingsArray (idrs_exception *pargException)
	Creates a new COcrZonalSettingsArray object.

Detailed Description

Interface for COcrZonalSettings wrapper.

Function Documentation

ArrayInterface_Create_COcrZonalSettingsArray()

COcrZonalSettingsArray ArrayInterface_Create_COcrZonalSettingsArray

(

idrs_exception *

pargException

)

Creates a new COcrZonalSettingsArray object.

Parameters

pargException

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

Returns

The newly created COcrZonalSettingsArray

COcrZonalSettings_Create()

COcrZonalSettings COcrZonalSettings_Create

(

idrs_exception *

pargException

)

Creates a new instance of this class.

Parameters

pargException

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

COcrZonalSettings_Destroy()

void COcrZonalSettings_Destroy	(	COcrZonalSettings	argCOcrZonalSettings,
		idrs_exception *	pargException
	)

Destroys a COcrZonalSettings handle.

Parameters

argCOcrZonalSettings	COcrZonalSettings handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrZonalSettings_GetContext()

COcrContext COcrZonalSettings_GetContext	(	const COcrZonalSettings	argCOcrZonalSettings,
		idrs_exception *	pargException
	)

Gets the associated ocr context.

The ocr context allows specifying options like languages to detect. See

See also

COcrContext for more details

Returns

Associated ocr context

Parameters

argCOcrZonalSettings	COcrZonalSettings handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrZonalSettings_GetZones()

COcrZoneDescriptionArray COcrZonalSettings_GetZones	(	const COcrZonalSettings	argCOcrZonalSettings,
		idrs_exception *	pargException
	)

Gets the array of zones where text recognition will be executed using the associated context.

Returns

Array of zones where text detection will be run

Parameters

argCOcrZonalSettings	COcrZonalSettings handle
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrZonalSettings_SetContext()

void COcrZonalSettings_SetContext	(	COcrZonalSettings	argCOcrZonalSettings,
		const COcrContext	argContext,
		idrs_exception *	pargException
	)

Sets the associated ocr context.

The ocr context allows specifying options like languages to detect. See

See also

COcrContext for more details

Parameters

argCOcrZonalSettings	COcrZonalSettings handle
argContext	Associated ocr context
pargException	Pointer to exception structure that will be filled if an exception occurs

COcrZonalSettings_SetZones()

void COcrZonalSettings_SetZones	(	COcrZonalSettings	argCOcrZonalSettings,
		const COcrZoneDescriptionArray	argxZones,
		idrs_exception *	pargException
	)

Sets the array of zones where text recognition will be executed using the associated context.

Setting one or more zones with coordinates outside the input page/image bounds will trigger an exception during text recognition.

Parameters

argCOcrZonalSettings	COcrZonalSettings handle
argxZones	Array of zones where text detection will be run
pargException	Pointer to exception structure that will be filled if an exception occurs