Edit

Share via

ISnapinAbout::GetSnapinDescription method (mmc.h)

  • Article

The ISnapinAbout::GetSnapinDescription method enables the console to obtain the text for the snap-in's description box.

Syntax

HRESULT GetSnapinDescription(
  [out] LPOLESTR *lpDescription
);

Parameters

[out] lpDescription

A pointer to the text for the description box on an About property page.

Return value

This method can return one of these values.

Remarks

The description should be limited to four lines of text to fit the description windows on the Snap-in Manager property pages.

Memory for out parameters must be allocated using the COM API function CoTaskMemAlloc.

Requirements

Requirement Value
Minimum supported client Windows Vista
Minimum supported server Windows Server 2008
Target Platform Windows
Header mmc.h

See also

ISnapinAbout