L_AnnGetLineFixedWidth
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetLineFixedWidth (hObject, pbLineFixedWidth)
HANNOBJECT hObject; |
/* handle to the annotation object */ |
L_BOOL *pbLineFixedWidth; |
/* pointer to a variable to be updated */ |
Gets a value that indicates whether the line width changes with scaling.
This function is available in the Document and Medical Imaging toolkits.
Parameter |
Description |
|
hObject |
Handle to the annotation object |
|
pbLineFixedWidth |
Pointer to a variable to be updated with a value that indicates whether the line width changes with scaling. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
The line width does not change with scaling. |
|
FALSE |
The line width changes with scaling. This is the default value. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
The line width of an object is relative to its container object, and the value is interpreted using the container's scaling factors. As a result, when zooming in the line width increases, and when zooming out the line width decreases. This is the default behavior.
In some cases it might be preferable to have the line width of an annotation object remain constant, regardless of the amount of scaling (zooming). To do this, call L_AnnSetLineFixedWidth function with the bLineFixedWidth parameter set to TRUE.
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_AnnSetLineFixedWidth.