Edit

IExtendTaskPad::GetDescriptiveText method (mmc.h)

  • Article

The IExtendTaskPad::GetDescriptiveText method enables MMC to get the taskpad's descriptive text to display in taskpads that use MMC taskpad templates.

Syntax

HRESULT GetDescriptiveText(
  [in]  LPOLESTR pszGroup,
  [out] LPOLESTR *pszDescriptiveText
);

Parameters

[in] pszGroup

A pointer to a null-terminated string that contains the group name that identifies the taskpad. The group name is the string that follows the hash (#) in the string passed in the ppViewType parameter when MMC calls IComponent::GetResultViewType to display the taskpad. If no group name is specified, szGroup is a NULL string.

[out] pszDescriptiveText

A pointer to the address of a null-terminated string that contains the descriptive text for the taskpad specified by pszGroup. This text is displayed at the top of the taskpad beneath the title for the entire taskpad. This text can be a phrase that serves as a subtitle or instructions (such as "Click an action to perform.").

If pszDescriptiveText points to a NULL string, no descriptive text is displayed.

Return value

This method can return one of these values.

Remarks

Allocate the pszDescriptiveText string with the COM API function CoTaskMemAlloc (or the equivalent) and MMC will release it.

Requirements

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

See also

IExtendTaskPad