IOleUndoUnit::GetDescription

Returns a string that describes the undo unit and can be used in the undo or redo user interface.

HRESULT GetDescription(
  BSTR* pbstr   //Pointer to string
);
 

Parameters

pbstr

[out] Pointer to string describing this undo unit.

Return Values

S_OK

The string was successfully returned.

Remarks

All units are required to provide a user-readable description of themselves.

Note to Callers

The *pbstr parameter is allocated with the standard string allocator. The caller is responsible for freeing this string.

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.