L_AnnGetAutoUndoEnable

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnGetAutoUndoEnable(hObject, pbEnable);

HANNOBJECT hObject;

/* handle to the automation object */

L_BOOL *pbEnable;

/* pointer to a variable to be updated */

Retrieves the state of the undo mechanism for an automation object. This function is available in the Document/Medical Toolkits.

Parameter

Description

hObject

Handle to the automation object.

pbEnable

Pointer to a variable to be updated with a value that indicates whether the undo mechanism for the automation object is enabled or disabled.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

To enable or disable a particular automation object, call L_AnnSetAutoUndoEnable.

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_AnnSetAutoUndoEnable, L_AnnGetUndoDepth, L_AnnSetUndoDepth, L_AnnUndo, L_AnnSetAutoHilightPen, L_AnnSetAutoSnapCursor, L_AnnGetAutoSnapCursor

Topics:

Undoing Automation Operations

 

Obtaining Annotation Object Information

 

Annotation Functions (Document/Medical only): Automation Properties

Example

For an example, refer to L_AnnGetAutoUndoEnable.