L_Doc2GetPaintZoomFactor

#include "ltdoc2.h"

L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2GetPaintZoomFactor(hDoc, nPageIndex, pfZoomFactor)

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

Parameters

L_HDOC2 hDoc

Handle to the OCR document.

L_INT nPageIndex

Index of the page for which to get the zoom factor. This index is zero-based.

L_FLOAT * pfZoomFactor

Pointer to a variable to be updated with the zoom factor for the specified page.

Returns

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

Comments

This function retrieves the zoom factor that was set using the L_Doc2SetPaintZoomFactor function. If the this function is called before the L_Doc2SetPaintZoomFactor / L_Doc2SetPaintZoomFactorExt function 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 also be drawn using the same zoom factor.

To draw the specified page, call the L_Doc2DrawPage / L_Doc2DrawPageExt function.

To set the zoom factor for a specific page, call the L_Doc2SetPaintZoomFactor / L_Doc2SetPaintZoomFactorExt function.

Required DLLs and Libraries

Help Version 21.0.2021.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS OCR Module - OmniPage Engine C API Help