LImageViewer::GetRulerUnit

#include "ltwrappr.h"

L_INT LImageViewer::GetRulerUnit(puUnit, uFlags)

L_UINT * puUnit;

/* pointer to a variable */

L_UINT uFlags;

/* reserved for future use */

Retrieves the measurement unit used for the viewer ruler.

Parameter

Description

puUnit

Pointer to a variable to be updated with the measurement unit used for the viewer ruler, or any other measurement tool inside the image viewer.  Possible values are:

 

Value

Meaning

 

CONTAINER_RULERUNIT_INCHES

[0] Inches.

 

CONTAINER_RULERUNIT_FEET

[1] Feet.

 

CONTAINER_RULERUNIT_MICROMETERS

[2] Micrometers.

 

CONTAINER_RULERUNIT_MILLIMETERS

[3] Millimeters.

 

CONTAINER_RULERUNIT_CENTIMETERS

[4] Centimeters. This is the default value.

 

CONTAINER_RULERUNIT_METERS

[5] Meters.

uFlags

Reserved for future use. Pass 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To change the viewer ruler unit, call the LImageViewer::SetRulerUnit function.

You can show the current measurement unit on the cell by passing the DISPWIN_TYPE_RULERUNIT to the parameter uType when calling the LImageViewer::SetCellTag function.

Required DLLs and Libraries

LTIVW

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:

LImageViewer::Create, LImageViewer::Destroy, LImageViewer::SetAction, LImageViewer::AddAction, LImageViewer::GetRulerUnit, LImageViewer::SetRulerUnit, LImageViewer::CalibrateRuler.

Topics:

Image Viewer Functions: The Annotation Feature.

 

The Annotation Feature

Example

For an example, refer to LImageViewer::CalibrateRuler.