L_AnnGetDistance

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetDistance(hObject, pdDistance, pdDistance2)

HANNOBJECT hObject;

handle to the annotation automation object

L_DOUBLE *pdDistance;

address of the variable that will be updated with the distance of a ruler object

L_DOUBLE *pdDistance2;

address of the variable that will be updated with the distance of a ruler object

Gets the distance of the Ruler object in the object's unit of measurement, set by L_AnnSetUnit.

Parameter

Description

hObject

Handle to the annotation automation object.

pdDistance

Address of the variable to be updated with the distance of the ruler object. For objects having only one ruler, this variable will be updated with the length. For cross products, which have two rulers, this variable will be updated with the length of the primary ruler.

pdDistance2

Address of the variable to be updated with the distance of the ruler object. For cross products and protractors, which have two rulers, this variable will be updated with the length of the secondary ruler.

Comments

Either pdDistance or pdDistance2 can be NULL, but not both. If either of these pointers is NULL, the distance for that ruler will not be retrieved.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

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.

Help Version 20.0.2018.1.19
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help