#include "ltdoc2.h"

L_LTDOC2_API L_INT L_Doc2GetZoneLayoutExt(hDoc, nDocId, nPageIndex, nZoneIndex, pprc, pnRectCount)

Gets the zone layout.


L_HDOC2 hDoc

Handle to the OCR document. This handle is obtained by calling the L_Doc2StartUp function.

L_INT nDocId

Document ID created by calling L_Doc2CreateDocument.

L_INT nPageIndex

Zero-based index of the page.

L_INT nZoneIndex

Zero-based index of the zone.

RECT ** pprc

Address of an array of RECT structures to be updated.

L_INT * pnRectCount

Address of a variable to be updated with the number of array elements.


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


Use L_Doc2GetZoneLayoutExt to obtain information about the shape of a specific zone in the user zone list of the specified page.

To use the function properly:

  1. Call it, passing NULL to pprc to get the element count of the rectangle array.
  2. Allocate an array of RECT structures.
  3. Call L_Doc2GetZoneLayoutExt a second time, passing the address of the allocated array to the pprc parameter to obtain the shape of the zone in terms of rectangles.

To set zone rectangles, call the L_Doc2SetZoneLayout / L_Doc2SetZoneLayoutExt function.

To add a user zone, call the L_Doc2AddZone / L_Doc2AddZoneExt function. To add rectangle(s) to a user zone to make its shape irregular, call the L_Doc2AddZoneRect / L_Doc2AddZoneRectExt 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