L_AnnShowLockedIcon
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnShowLockedIcon (hObject, bShow, uFlags)
|
HANNOBJECT hObject; |
/* handle to the annotation object */ |
|
L_BOOL bShow; |
/* flag that indicates whether to show the padlock icon */ |
|
L_UINT uFlags; |
/* flags to determine which objects to process */ |
Enables and disables the displaying of the padlock icon on top of locked objects. This function is available in the Document/Medical Toolkits.
|
Parameter |
Description |
|
|
hObject |
Handle to the annotation object. |
|
|
bShow |
Flag that indicates whether to show the padlock icon. Possible values are: |
|
|
|
Value |
Meaning |
|
|
TRUE |
Show the padlock icon on top of locked objects. |
|
|
FALSE |
Do not show the padlock icon on top of locked objects. |
|
uFlags |
Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( | ). The following are valid values: |
|
|
|
Value |
Meaning |
|
|
0 |
Process only the specified object. |
|
|
ANNFLAG_SELECTED |
[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the L_AnnGetSelected and L_AnnSetSelected functions. |
|
|
ANNFLAG_NOTTHIS |
[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not. |
|
|
ANNFLAG_RECURSE |
[0x0008] Process objects within a container, and within any subcontainers, down to any level. |
|
|
ANNFLAG_NOTCONTAINER |
[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves. |
|
|
ANNFLAG_NOINVALIDATE |
[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
A locked object will be displayed with a padlock on top if L_ShowLockedIcon has been called with bShow set to TRUE.
Note that this information will not be saved when calling L_AnnSave so you should call L_AnnShowLockedIcon with the desired value after calling any of the annotation loading functions, L_AnnLoad, L_AnnLoadMemory, L_AnnLoadOffset.
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
|
Functions: |
L_AnnUnlock, L_AnnShowLockedIcon, L_AnnUnrealize, L_AnnRealize, L_AnnLoad, L_AnnLoadMemory, L_AnnLoadOffset, L_AnnGetSelected, L_AnnSetSelected |
|
Topics |
|
|
|
|
|
|
|
|
|
Example
For an example, refer to L_AnnGetLocked.