Interface for CImageLimits wrapper. More...

Functions
IDRS_UINT32	CImageLimits_GetImageMaxWidth (idrs_exception *pargException)
	GetImageMaxWidth returns the maximum width in pixels for an image to be used with iDRS SDK.

IDRS_UINT32	CImageLimits_GetImageMaxHeight (idrs_exception *pargException)
	GetImageMaxHeight returns the maximum height in pixels for an image to be used with iDRS SDK.

IDRS_UINT32	CImageLimits_GetImageMaxSize (idrs_exception *pargException)
	GetImageMaxSize returns the maximum number of pixels for an image to be used with iDRS SDK.

IDRS_UINT32	CImageLimits_GetImageMinResolution (idrs_exception *pargException)
	GetImageMinResolution returns the minimum resolution in dpi that can be used by the recognition engine.

IDRS_UINT32	CImageLimits_GetImageMaxResolution (idrs_exception *pargException)
	GetImageMaxResolution returns the maximum resolution in dpi that can be used by the recognition engine.

IDRS_UINT32	CImageLimits_GetCharacterMaxHeight (IDRS_UINT32 const uiResolution, idrs_exception *pargException)
	GetCharacterMaxHeight returns the maximum character height, at the supplied resolution.

IDRS_UINT32	CImageLimits_GetLineMaxHeight (IDRS_UINT32 const uiResolution, idrs_exception *pargException)
	GetLineMaxHeight returns the maximum line height, at the supplied resolution.

IDRS_BOOL	CImageLimits_CheckPageLimits (const CPage argPage, idrs_exception *pargException)
	CheckPageLimits verifies the limits of the supplied CPage object.

IDRS_BOOL	CImageLimits_CheckPageLimits2 (IDRS_UINT32 const uiWidth, IDRS_UINT32 const uiHeight, idrs_exception *pargException)
	CheckPageLimits verifies if the supplied width and height are within the minimum and maximum image limits.

IDRS_BOOL	CImageLimits_CheckPageResolution (const CPage argPage, idrs_exception *pargException)
	CheckPageLimits verifies the resolution of the supplied CPage object is in the min and max resolution interval.

IDRS_BOOL	CImageLimits_CheckPageResolution2 (IDRS_UINT32 const uiResolution, idrs_exception *pargException)
	CheckPageResolution verifies that the supplied resolution is within recognition accepted limits.

Detailed Description

Interface for CImageLimits wrapper.

Function Documentation

◆ CImageLimits_CheckPageLimits()

IDRS_BOOL CImageLimits_CheckPageLimits	(	const CPage	argPage,
		idrs_exception *	pargException
	)

CheckPageLimits verifies the limits of the supplied CPage object.

Parameters

argPage	CPage object that will be verified
pargException	Pointer to exception structure that will be filled if an exception occurs

Return values

IDRS_TRUE	if argPage contains an image that can be used for recognition
IDRS_FALSE	if argPage internal image is not suitable for recognition

◆ CImageLimits_CheckPageLimits2()

IDRS_BOOL CImageLimits_CheckPageLimits2	(	IDRS_UINT32 const	uiWidth,
		IDRS_UINT32 const	uiHeight,
		idrs_exception *	pargException
	)

CheckPageLimits verifies if the supplied width and height are within the minimum and maximum image limits.

Parameters

uiWidth	Image width
uiHeight	Image height
pargException	Pointer to exception structure that will be filled if an exception occurs

Return values

IDRS_TRUE	if the width and height are ok
IDRS_FALSE	if the width or height of the image exceeds the max limits

◆ CImageLimits_CheckPageResolution()

IDRS_BOOL CImageLimits_CheckPageResolution	(	const CPage	argPage,
		idrs_exception *	pargException
	)

CheckPageLimits verifies the resolution of the supplied CPage object is in the min and max resolution interval.

Parameters

argPage	CPage object that will be verified
pargException	Pointer to exception structure that will be filled if an exception occurs

Return values

IDRS_TRUE	if the argPage contains an image with a resolution that can be used for recognition
IDRS_FALSE	if the argPage internal image has a resolution not suitable for recognition

◆ CImageLimits_CheckPageResolution2()

IDRS_BOOL CImageLimits_CheckPageResolution2	(	IDRS_UINT32 const	uiResolution,
		idrs_exception *	pargException
	)

CheckPageResolution verifies that the supplied resolution is within recognition accepted limits.

Parameters

uiResolution	resolution to verify
pargException	Pointer to exception structure that will be filled if an exception occurs

Return values

IDRS_TRUE	if the supplied resolution can be used for recognition
IDRS_FALSE	if the supplied resolution is not suitable for recognition

◆ CImageLimits_GetCharacterMaxHeight()

IDRS_UINT32 CImageLimits_GetCharacterMaxHeight	(	IDRS_UINT32 const	uiResolution,
		idrs_exception *	pargException
	)

GetCharacterMaxHeight returns the maximum character height, at the supplied resolution.

Parameters

uiResolution	Image resolution
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns: The maximum character height in pixels for the supplied resolution