L_Doc2GetPaintZoomFactor
#include "ltdoc2.h"
L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2GetPaintZoomFactor(hDoc, nPageIndex, pfZoomFactor)
L_HDOC2 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 |
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 the L_Doc2SetPaintZoomFactor function. If the L_Doc2GetPaintZoomFactor function is called before the L_Doc2SetPaintZoomFactor 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 function.
To set the zoom factor for a specific page, call the L_Doc2SetPaintZoomFactor function.
Required DLLs and Libraries
LTDOC2 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
Example
For an example, refer to L_Doc2SetPaintZoomFactor.