IOleUndoUnit::GetDescription method

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

pBstr [out]

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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OCIdl.h

IDL

OCIdl.idl

IID

IID_IOleUndoUnit is defined as 894AD3B0-EF97-11CE-9BC9-00AA00608E01

See also

IOleUndoUnit

 

 

Show: