L_DispContainerGetRulerUnit

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerGetRulerUnit(hCellWnd, puUnit, uFlags)

L_HWND hCellWnd;

handle to the cell window

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
hCellWnd A handle to the window that represents the Medical Viewer Cell.
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 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

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.

Help Version 19.0.2017.10.18
Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Medical Image Viewer C API Help