L_AnnGetTicMarkLength
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetTicMarkLength(hObject, pdLength)
|
HANNOBJECT hObject; |
/* handle to the annotation automation object */ |
|
L_DOUBLE *pdLength; |
/* address of the variable to be updated */ |
Gets the length of the tic mark of an ANNOBJECT_RULER or ANNOBJECT_POLYRULER. The tic marks are the perpendicular lines that measure the units. This function is available in the Document/Medical Toolkits.
|
Parameter |
Description |
|
hObject |
Handle to the annotation automation object. |
|
pdLength |
Address of the variable to be updated with the object's tic mark length. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
The tic mark length applies only to the following annotation objects:
ANNOBJECT_AUTOMATION
ANNOBJECT_RULER
ANNOBJECT_POLYRULER
The dLength parameter is expressed in pixels, not in points. The length is for the whole line, not just from the intersection point with the ruler to the end point of the tic mark - it is from one end of the tic mark to the other end of the tic mark.
Note that a ruler can have tic marks of different lengths. For Example, the ruler in the figure below has tic marks with several different lengths. In this case, pdLength is updated with the length of the longest tic mark.
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. |
Platforms
Windows 2000 / XP/Vista.
See Also
Example
For an Example, refer to L_AnnSetTicMarkLength.