L_AnnGetDistance

#include "l_bitmap.h"

L_INT EXT_FUNCTION L_AnnGetDistance(hObject, pdDistance, pdDistance2)

HANNOBJECT hObject;

/* handle to the annotation automation object */

L_DOUBLE L_FAR *pdDistance;

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

L_DOUBLE L_FAR *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. This function is available in the Document/Medical Toolkits.

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

Windows 95 / 98 / Me, Windows 2000 / XP.

See Also

Functions:

L_AnnSetBitmapDpiX, L_AnnGetBitmapDpiX, L_AnnGetBitmapDpiY, L_AnnSetBitmapDpiY, L_AnnSetUnit, L_AnnGetUnitLen, L_AnnGetUnit, L_AnnSetGaugeLength, L_AnnGetGaugeLength, L_AnnGetTicMarkLength, L_AnnSetTicMarkLength, L_AnnGetDistance2, ANNSMARTDISTANCE

Topics:

Annotation Functions: Working with the Toolbar

 

Implementing Annotations

 

Annotation Objects - Default Values

 

Annotation Objects - Automated Features

 

Automated User Interface for Annotations

 

Implementing an Automated Annotation Program

 

Obtaining Annotation Object Information

 

Using Rulers in Annotation Objects

 

New Annotation Features of Version 14.5

 

Calibrating Annotation Ruler Objects

Example

For an example, refer to L_AnnSetUnit.