L_AnnSetAutoUndoEnable
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnSetAutoUndoEnable(hObject, bEnable);
HANNOBJECT hObject; |
/* handle to the automation object */ |
L_BOOL bEnable; |
/* flag that indicates whether to enable undo */ |
Enables or disables the undo mechanism for an automation object.
This function is available in the Document and Medical Imaging toolkits.
Parameter |
Description |
hObject |
Handle to the automation object. |
bEnable |
Flag that indicates whether to enable or disable the undo mechanism for the automation object. Possible values are: |
|
Value |
Meaning |
|
TRUE |
Enable the undo mechanism for the specified automation object. |
|
FALSE |
Disable the undo mechanism for the specified automation object. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
Use this function along with L_AnnAddUndoNode to combine multiple changes into a single undo call. For more information on this process, refer to L_AnnAddUndoNode.
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_AnnAddUndoNode, L_AnnGetAutoUndoEnabled, L_AnnGetUndoDepth, L_AnnSetUndoDepth, L_AnnUndo, L_AnnSetAutoHilightPen, L_AnnSetAutoSnapCursor, L_AnnGetAutoSnapCursor |
Topics: |
|
|
Example
For an example, refer to L_AnnGetAutoUndoEnable.