IOleUndoManager::Enable method

Enables or disables the undo manager.

Syntax


HRESULT Enable(
  [in] BOOL fEnable
);

Parameters

fEnable [in]

Indicates whether to enable or disable the undo manager. If TRUE, the undo manager should be enabled. If FALSE, the undo manager should be disabled.

Return value

This method returns S_OK if the undo manager was successfully enabled or disabled. Other possible return values include the following.

Return codeDescription
E_UNEXPECTED

There is an open undo unit on the stack or the undo manager is currently performing an undo or a redo.

 

Remarks

The undo manager should clear both stacks when making the transition from enabled to disabled.

If the undo manager is disabled, each method in IOleUndoManager must behave as specified. See each method for details.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OCIdl.h

IDL

OCIdl.idl

IID

IID_IOleUndoManager is defined as D001F200-EF97-11CE-9BC9-00AA00608E01

See also

IOleUndoManager

 

 

Show: