L_AnnGetAutoDrawEnable
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetAutoDrawEnable(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 left mouse button is enabled for automated drawing in design mode.
Parameter |
Description |
|
hObject |
Handle to an automation object. |
|
pfEnable |
Address of the variable to be updated with the value that indicates whether the left mouse button is enabled for automated drawing in design mode. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
The left mouse button is enabled for automated drawing in design mode. |
|
FALSE |
The left mouse button is disabled for automated drawing in design mode. |
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 drawing status.
For enabling or disabling the automated drawing, refer to L_AnnSetAutoDrawEnable.
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. |
Win32, x64.
See Also
Functions: |
|
|
|
|
L_AnnSetAutoDrawEnable, L_AnnSetAutoText, L_AnnSetAutoHilightPen, L_AnnSetAutoSnapCursor, L_AnnGetAutoSnapCursor |
Topics: |
|
|
|
|
|
|
|
|
|
|
|
|
Annotation Functions (Document/Medical only): Automation Properties |
Example
For an example, refer to L_AnnSetAutoDrawEnable.