L_Doc2GetZoneColor

#include "ltdoc2.h"

L_LTDOC2_API L_INT EXT_FUNCTION L_Doc2GetZoneColor(hDoc, nPageIndex, nZoneIndex, pClr)

L_HDOC2 hDoc;

/* handle to the OCR document */

L_INT nPageIndex;

/* page index */

L_INT nZoneIndex;

/* zone index */

COLORREF * pClr;

/* Address of variable to be updated */

Gets the color of the specified zone on the specified page.

Parameter

Description

hDoc

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

nPageIndex

Index of the page. This is a zero-based index.

nZoneIndex

Index of the zone. This is a zero-based index.

pClr

Address of a variable to be updated with the color of the zone.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function will get the zone color only for those zones that the engine detects on the specified page. Use the zone index from the zones list that the engine detects.

To get the number of zones that the engine detected, call the L_Doc2GetZoneCount function.

Call the L_Doc2FindZones function to have the engine detect the zones on a specific page.

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

Functions:

L_Doc2AddZone, L_Doc2UpdateZone, L_Doc2GetZoneCount, L_Doc2GetZone, L_Doc2RemoveZone, L_Doc2ImportZones, L_Doc2ExportZones, L_Doc2FindZones, L_Doc2SetZoneOptions, L_Doc2GetZoneOptions, L_Doc2AddZoneRect, L_Doc2GetZoneLayout, L_Doc2GetZoneNodes, L_Doc2ExcludeZoneRect, L_Doc2SetZoneLayout

Topics:

Working with Zones

Example

For an example, refer to L_Doc2SetZoneLayout