LAnnotation::GetRgnHandle

#include "ltwrappr.h"

virtual L_INT LAnnotation::GetRgnHandle(phRgn, pXForm=NULL)

HRGN * phRgn;

/* address of the variable to be updated */

pRGNXFORM pXForm;

/* pointer to a coordinate translation structure */

Creates a region from the specified annotation object and retrieves a handle to that region.

Parameter

Description

phRgn

Address of the variable to be updated with the handle to the region, if the function is successful.

pXForm

Pointer to an RGNXFORM structure that LEADTOOLS uses to translate between display coordinates and bitmap coordinates.

 

If you specify NULL in this parameter, the scalar fields default to 1, the offsets default to 0, and the view perspective defaults to TOP_LEFT.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

You can create regions from the following annotation objects:

ANNOBJECT_FREEHAND

ANNOBJECT_POLYLINE

ANNOBJECT_POLYGON

ANNOBJECT_RECT

ANNOBJECT_ELLIPSE

ANNOBJECT_FREEHANDHOTSPOT

ANNOBJECT_HOTSPOT

ANNOBJECT_STAMP

ANNOBJECT_NOTE

ANNOBJECT_TEXT

ANNOBJECT_HILITE

ANNOBJECT_BUTTON

ANNOBJECT_REDACT

When working with the RGNXFORM structure in this function, consider the following:

the annotations are always TOP_LEFT.

the bitmap is missing, so the bitmap rectangle is replaced by the object rectangle.

it is easier to work with this function using TOP_LEFT as the ViewPerspective.

Required DLLs and Libraries

LTANN

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

Platforms

Win32, x64.

See Also

Functions:

Class Members

Example

For an example, refer to LAnnotation::GetArea.