LAnnRuler::GetUnit
#include "ltwrappr.h"
virtual L_UINT LAnnRuler::GetUnit(pUnitAbbrev, puUnivAbbrevLen, puPrecision)
|
L_TCHAR * pUnitAbbrev; |
/* character string to be updated */ |
|
L_SIZE_T *puUnivAbbrevLen; |
/* address of the integer variable to be updated with the unit abbreviation string length */ |
|
L_UINT * puPrecision; |
/* pointer to a variable to be updated */ |
Gets the current unit of measurement values set by the LAnnRuler::SetUnit function. This function is available in the Document/Medical Toolkits.
|
Parameter |
Description |
|
pUnitAbbrev |
Character string to be updated with the unit abbreviation string to be displayed after the distance. |
|
puUnivAbbrevLen |
Address of the variable to be updated with the length of the unit abbreviation string. |
|
puPrecision |
Pointer to the variable to be updated with the number of digits to be displayed after the decimal place. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
The following annotation objects utilize one or more rulers as part of the annotation:
ANNOBJECT_CROSSPRODUCT
ANNOBJECT_POLYRULER
ANNOBJECT_PROTRACTOR
ANNOBJECT_RULER
In addition, the Automation object (ANNOBJECT_AUTOMATION) stores default ruler settings along with the other object default settings.
To determine the unit of measure for each ruler as well as its precision, call the LAnnAutomation::GetUnit function or the LAnnRuler::GetUnit function. The default unit of measure for Ruler, Polyruler, and Crossproduct objects is Smart English. With the smart units, the unit changes with the length. For example, if the length is 11 inches (assuming the default precision of 2 is being used), "11.00 in" displays whereas if the length is 15 inches, "1 ft 3.00 in" displays. Call the LAnnAutomation::SetUnit or the LAnnRuler::SetUnit function to set the unit of measurement and its precision for the ruler. The precision indicates how many digits to display to the right of the decimal point in the length.
Required DLLs and Libraries
|
LTANN 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: |
Class Members, LAnnPolyRuler::GetDistance2, ANNSMARTDISTANCE, LAnnotation::CalibrateRuler |
|
Topics: |
|
|
|
|
|
|
|
|
|
|
|
|
Example
For an example, refer to LAnnRuler::SetUnit.