IOleUndoUnit::GetDescription method (ocidl.h)

Retrieves a description of the undo unit that can be used in the undo or redo user interface.

Syntax

HRESULT GetDescription(
  [out] BSTR *pBstr
);

Parameters

[out] pBstr

A pointer to string that describes this undo unit.

Return value

This method returns S_OK on success.

Remarks

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

Notes to Callers

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

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header ocidl.h

See also

IOleUndoUnit