L_DocGetPaintZoomFactor

#include "ltdoc.h"

L_LTDOC_API L_INT L_DocGetPaintZoomFactor (hDoc, nPageIndex, pfZoomFactor)

L_HDOC hDoc;	/* handle to the OCR document. */
L_INT nPageIndex;	/* page index */
L_FLOAT * pfZoomFactor;	/* pointer to a variable */

Gets the zoom factor used to draw the specified OCR page.

Parameter	Description
hDoc	Handle to the OCR document.
nPageIndex	Specifies the index of the page for which to get the zoom factor. This index is zero-based.
pfZoomFactor	Pointer to a variable to be updated with the zoom factor for the specified page.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function retrieves the zoom factor that was set using L_DocSetPaintZoomFactor. If L_DocGetPaintZoomFactor is called before L_DocSetPaintZoomFactor has been called, pfZoomFactor will be updated with the default value 100, which represents normal display.

The specified page may or may not contain zones. If the page has zones, the zones will be drawn using the zoom factor too.

To draw the specified page, call L_DocDrawPage.

To set the zoom factor for a specific page, call L_DocSetPaintZoomFactor.

Required DLLs and Libraries

LTDOC

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:	L_DocSetPaintZoomFactor, L_DocRecognize, L_DocDrawPage, L_DocLockPage, L_DocUnlockPage, L_DocSetActivePage, L_DocSelectZoneByPoint, L_DocSelectZone, L_DocRemoveSelectedZone, L_DocSetZonePen, L_DocSetSelectedZonePen, L_DocGetSelectedZone, L_DocZone
Topics:	Drawing Pages and Zones
	OCR Functions: Drawing Zones and Pages

Example

For an example, refer to L_DocSetPaintZoomFactor.