L_DispContainerSetRulerUnit

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerSetRulerUnit(hCon, uUnit, uFlags)

HDISPCONTAINER hCon;

/* handle to the container */

L_UINT uUnit;

/* measurement unit */

L_UINT uFlags;

/* reserved for future use */

Changes the measurement unit used for the viewer ruler.

Parameter

Description

hCon

Handle to the container.

uUnit

Value that represents the measurement unit used for the viewer ruler. 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.

 

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 retrieve the current measurement unit used for the viewer ruler, call the L_DispContainerGetRulerUnit function.

The annotation ruler and the cell ruler measurement unit values change depending on the value passed to the uUnit parameter.

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:

L_DispContainerCreate, L_DispContainerDestroy, L_DispContainerSetAction, L_DispContainerAddAction, L_DispContainerSetRulerUnit, L_DispContainerCalibrateRuler

Topics:

Working with Annotations

Image Viewer Functions: Working with Annotations

Example

For an example, refer to L_DispContainerCalibrateRuler