L_AnnGetAutoMenuItemEnable
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetAutoMenuItemEnable(hObject, nObjectType, uItem, puEnable)
|
HANNOBJECT hObject; |
/* handle to the annotation object */ |
|
L_INT nObjectType; |
/* type of annotation object */ |
|
L_UINT uItem; |
/* constant for the specified item */ |
|
L_UINT * puEnable; |
/* address of a variable to be updated */ |
Retrieves a value that indicates whether the specified menu item is enabled or disabled. This function is available in the Document/Medical Toolkits.
|
Parameter |
Description |
|
|
hObject |
Handle to the annotation object. |
|
|
nObjectType |
Constant that specifies an object's type. For descriptions of possible object types, refer to Types of Annotations. This parameter is valid only if hObject is an automation object. |
|
|
uItem |
Constant that specifies the menu or dialog box item to enable or disable. For lists of constants and their default values, refer to the following: |
|
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
puEnable |
Address of a variable to be updated with a value that indicates whether the specified menu item has been enabled or disabled for the object. Possible values are: |
|
|
|
Value |
Meaning |
|
|
ANNMENU_ENABLED |
Enable the menu item. |
|
|
ANNMENU_DISABLED |
Disable the menu item. |
|
|
ANNMENU_DEFAULT |
Enable or disable the menu item, based on the setting for the object type. |
Returns
|
SUCCESS |
The function was successful. |
|
< 1 |
An error occurred. Refer to Return Codes. |
Comments
If for the specified object, the menu items enable state is ANNMENU_DEFAULT, the function determines whether the enable state has been set for objects of the specified type. If the enable state for objects of the specified type is also ANNMENU_DEFAULT, the function determines whether the enable state has been set for ANNOBJECT_ALL. If this is also ANNMENU_DEFAULT, the function determines whether the menu item text is NULL or not NULL. If it is NULL, the function updates puEnable with ANNMENU_DISABLE. If the menu item is not NULL, the function updates puEnable with ANNMENU_ENABLE.
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_AnnSetAutoMenuState, L_AnnSetAutoHilightPen, L_AnnSetAutoSnapCursor, L_AnnGetAutoSnapCursor |
|
Topics: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Annotation Functions (Document/Medical only): Automation Properties |
Example
For an example, refer to L_AnnSetAutoMenuItemEnable.