L_AnnGetFixed
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetFixed(hObject, pbFixed)
HANNOBJECT hObject; |
/* handle to the annotation object */ |
L_BOOL *pbFixed; |
/* address of a variable to be updated */ |
Gets a value that indicates whether the annotation is fixed. This function is available in the Document/Medical Toolkits.
Parameter |
Description |
|
hObject |
Handle to the annotation object |
|
pbFixed |
Address of the variable to be updated with a value that indicates whether the annotation is fixed. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
The annotation object is fixed. |
|
FALSE |
The annotation object is not fixed. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
A fixed annotation does not move or change size when the annotation container's scalars and offsets are changed. The effect is that the annotation does not move or change size when the underlying image is scrolled or zoomed.
The following annotations cannot be fixed:
ANNOBJECT_CONTAINER
ANNOBJECT_REDACT
ANNOBJECT_ENCRYPT
For more information, refer to Fixed Annotations.
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_AnnSetFixed.