L_AutSetUndoEnabled

#include "ltaut.h"

L_LTAUT_API L_INT L_AutSetUndoEnabled (pAutomation, bEnabled);

Disables or re-enables the undo feature of the automation handle.

Parameters

pAUTOMATIONHANDLE pAutomation

Pointer to an automation handle.

L_BOOL bEnabled

Flag that indicates whether to enable or disable the undo feature of the specified automation handle. By enabling or disabling the undo feature, the internal undo counter is incremented or decremented. Possible values are:

Value Meaning
TRUE Enable the undo feature and increment the internal undo counter by one.
FALSE Disable the undo feature and decrement the internal undo counter by one.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

This function sets an internal automation counter that determines whether the undo feature should be displayed. The undo feature is on only if this counter is greater than or equal to 0. The initial value is 0.

Use this function along with L_AutAddUndoNode to combine multiple operations into a single undo call. For more information on this process, refer to L_AutAddUndoNode.

Required DLLs and Libraries

Help Version 21.0.2021.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Container and Automation C API Help