L_AnnGetAutoMenuEnable
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetAutoMenuEnable(hObject, pfEnable)
HANNOBJECT hObject; |
/* handle to an annotation automation object */ |
L_BOOL * pfEnable; |
/* address of the variable to be updated */ |
Gets a value that indicates whether the automated menus for annotation are enabled.
This function is available in the Document and Medical Imaging toolkits.
Parameter |
Description |
|
hObject |
Handle to an annotation automation object. |
|
pfEnable |
Address of the variable to be updated with a value indicating whether the annotation automated menus are enabled. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
Menus are enabled |
|
FALSE |
Menus are disabled. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Before calling this function, you must declare a variable of data type L_BOOL. Then pass the address of the variable in the pfEnable parameter. This function will update the variable with the automation object's current menu status.
For enabling or disabling the menus, refer to L_AnnSetAutoMenuEnable.
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_AnnGetAutoDrawEnable, L_AnnSetAutoText, L_AnnSetAutoHilightPen, L_AnnSetAutoSnapCursor, L_AnnGetAutoSnapCursor |
Topics: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Annotation Functions (Document/Medical only): Automation Properties |
Example
Refer to L_AnnSetAutoMenuEnable.