IExtendTaskPad::GetDescriptiveText 方法 (mmc.h)

借助 IExtendTaskPad::GetDescriptiveText 方法,MMC 可以获取任务板的描述性文本,以在使用 MMC 任务板模板的任务板中显示。

语法

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

参数

[in] pszGroup

指向以 null 结尾的字符串的指针,该字符串包含标识任务板的组名称。 组名称是 MMC 调用 IComponent::GetResultViewType 以显示任务板时,在 ppViewType 参数中传递的字符串中的哈希 (#) 之后的字符串。 如果未指定组名称,则 szGroup 为 NULL 字符串。

[out] pszDescriptiveText

指向以 null 结尾的字符串的地址的指针,该字符串包含 pszGroup 指定的任务板的描述性文本。 此文本显示在整个任务板标题下方的任务板顶部。 此文本可以是用作副标题或说明 (的短语,例如“单击要执行的操作”。) 。

如果 pszDescriptiveText 指向 NULL 字符串,则不显示描述性文本。

返回值

此方法可以返回其中一个值。

注解

使用 COM API 函数 CoTaskMemAlloc 分配 pszDescriptiveText 字符串 (或等效) ,MMC 将释放它。

要求

要求
最低受支持的客户端 Windows Vista
最低受支持的服务器 Windows Server 2008
目标平台 Windows
标头 mmc.h

另请参阅

IExtendTaskPad