Skip to content

Latest commit

 

History

History
133 lines (102 loc) · 4.32 KB

nf-ocidl-ioleundomanager-redoto.md

File metadata and controls

133 lines (102 loc) · 4.32 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:ocidl.IOleUndoManager.RedoTo
IOleUndoManager::RedoTo (ocidl.h)
Instructs the undo manager to invoke undo actions back through the redo stack, down to and including the specified undo unit.
IOleUndoManager interface [COM]
RedoTo method
IOleUndoManager.RedoTo
IOleUndoManager::RedoTo
RedoTo
RedoTo method [COM]
RedoTo method [COM]
IOleUndoManager interface
_ole_ioleundomanager_redoto
com.ioleundomanager_redoto
ocidl/IOleUndoManager::RedoTo
com\ioleundomanager_redoto.htm
com
1d5d0cb6-2c1b-49c8-8923-59845fa6231c
12/05/2018
IOleUndoManager interface [COM],RedoTo method, IOleUndoManager.RedoTo, IOleUndoManager::RedoTo, RedoTo, RedoTo method [COM], RedoTo method [COM],IOleUndoManager interface, _ole_ioleundomanager_redoto, com.ioleundomanager_redoto, ocidl/IOleUndoManager::RedoTo
ocidl.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
OCIdl.idl
Windows
19H1
IOleUndoManager::RedoTo
ocidl/IOleUndoManager::RedoTo
c++
APIRef
kbSyntax
COM
OCIdl.h
IOleUndoManager.RedoTo

IOleUndoManager::RedoTo

-description

Instructs the undo manager to invoke undo actions back through the redo stack, down to and including the specified undo unit.

-parameters

-param pUU [in]

An IOleUndoUnit pointer to the top level unit to redo. If this parameter is NULL, the most recently added top level unit is used.

-returns

This method returns S_OK on success. Other possible return values include the following.

Return code Description
E_INVALIDARG
The specified undo unit is not on the redo stack.
E_ABORT
Both the undo attempt and the rollback attempt failed. The undo manager should never propagate the E_ABORT obtained from a contained undo unit. Instead, it should map any E_ABORT values returned from other undo units to E_FAIL.
E_UNEXPECTED
The undo manager is disabled.

-remarks

This method calls the IOleUndoUnit::Do method on each top-level undo unit. Then, it releases that undo unit.

Note that the specified undo unit must be a top-level unit, typically retrieved through IOleUndoManager::EnumRedoable.

In case an error is returned from the undo unit, the undo manager needs to attempt to rollback the state of the document to recover from the error by performing actions on the undo stack.

No matter what the success of the rollback, the undo manager should always clear both stacks before returning the error.

If the undo manager has called the IOleUndoUnit::Do method on more than one top-level unit, it should only rollback the unit that returned the error. The top-level units that succeeded should not be rolled back.

The undo manager must also keep track of whether units were added to the opposite stack so it won't attempt rollback if nothing was added. See the IOleUndoManager interface for detailed description of error handling.

-see-also

IOleUndoManager

IOleUndoManager::EnumRedoable

IOleUndoManager::UndoTo

IOleUndoUnit::Do