IOleUndoManager::EnumUndoable

Creates an enumerator object that the caller can use to iterate through a series of top-level undo units from the undo stack.

HRESULT EnumUndoable(
  IEnumOleUndoUnits** ppEnum   //Address of output variable that 
                               // receives the IEnumOleUndoUnits 
                               // interface pointer
);

Parameters

ppEnum: [out] Address of IEnumOleUndoUnits* pointer variable that receives the interface pointer to the enumerator object.

Return Values

S_OK: The enumerator object was successfully created and the interface pointer was returned.
E_UNEXPECTED: The undo manager is disabled.

Remarks

A new enumerator object is created each time this method is called. If the series of enumerated items changes over time, the results of enumeration operations can vary from one call to the next.

This method calls AddRef on the new enumerator object to increment its reference count. The caller is responsible for calling Release on the enumerator object when it is no longer needed.

QuickInfo

  Windows NT: Use version 4.0 or later. New for OC96.
  Windows: Use Windows 95 or later. New for OC96.
  Windows CE: Unsupported.
  Header: Declared in ocidl.h.