This topic has not yet been rated - Rate this topic

IOleUndoManager::GetLastUndoDescription method

Applies to: desktop apps only

Retrieves the description for the top-level undo unit that is on top of the undo stack.

Syntax

Copy

HRESULT GetLastUndoDescription(
  [out]  BSTR *pBstr
);

Parameters

pBstr [out]: A pointer to a string that contains a description of the top-level undo unit on the undo stack.

Return value

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

Return code	Description
E_FAIL	The undo stack is empty.
E_UNEXPECTED	The undo manager is disabled.

Remarks

This method provides a convenient shortcut for the host application to add a description to its Edit Undo menu item. The pBstr parameter is a string allocated with the standard string allocator. The caller is responsible for freeing this string.

Requirements