L_DispContainerGetRulerUnit

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerGetRulerUnit(hCellWnd, puUnit, uFlags)

Retrieves the measurement unit used for the viewer ruler.

Parameters

L_HWND hCellWnd

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

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

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 change the viewer ruler unit, call the L_DispContainerSetRulerUnit function.

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

Required DLLs and Libraries

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

LEADTOOLS Medical Image Viewer C API Help