L_AnnGetGaugeLength

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetGaugeLength(hObject, pdLength)

HANNOBJECT hObject;

/* handle to the annotation automation object */

L_DOUBLE *pdLength;

/* address of the variable to be updated */

Gets the length of the gauge (the perpendicular lines at the ends of the Ruler object).

This function is available in the Document and Medical Imaging toolkits.

Parameter

Description

hObject

Handle to the annotation automation object.

pdLength

Address of the variable to be updated with the object's gauge length.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The gauge length applies only to Automation and Ruler objects. Refer to Annotation Automation Object.

dLength is expressed in pixels, not in points. The length is for the whole line, not just from the end point of the ruler to the end point of the gauge - it is from one end of the gauge to the other end of the gauge.

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 2000 / XP/Vista.

See Also

Functions:

L_AnnSetGaugeLength, L_AnnSetBitmapDpiX, L_AnnGetBitmapDpiX, L_AnnGetBitmapDpiY, L_AnnSetBitmapDpiY, L_AnnSetUnit, L_AnnGetUnit, L_AnnGetUnitLen, L_AnnGetDistance, 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

 

Annotation Features

 

Calibrating Annotation Ruler Objects

Example

For an example, refer to L_AnnSetGaugeLength.