L_DispContainerSetRulerUnit

Summary

Changes the measurement unit used for the viewer ruler.

Syntax

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerSetRulerUnit(hCellWnd, uUnit, uFlags)

Parameters

L_HWND hCellWnd

A handle to the window that represents the Medical Viewer Cell.

L_UINT 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.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Value Meaning
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

See Also

Functions

Topics

Example

For an example, refer to L_DispContainerCalibrateRuler

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Medical Image Viewer C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.