MMCPropertyHelp 函数 (mmc.h)

MMCPropertyHelp 函数在 MMC 1.1 中引入。

MMCPropertyHelp 函数在属性页的合并 MMC HTML 帮助文件中显示指定的 HTML 帮助主题。

语法

HRESULT MMCPropertyHelp(
  LPOLESTR pszHelpTopic
);

parameters

pszHelpTopic

指向以 NULL 结尾的字符串的指针,指定要在合并的 MMC HTML 帮助文件中显示的主题。 字符串必须具有以下格式:

helpfilename::topicfilename

其中 helpfilename 是管理单元的 HTML 帮助文件的文件名 (.chm) MMC 合并到 MMC HTML 帮助文件的文件名 (文件名,而不是原始 HTML 帮助文件) 和 topicfilename 是管理单元 .chm 文件中主题文件的内部路径。 管理单元的 HTML 帮助文件的作者确定主题 HTML 文件是否存在内部目录结构,或者所有主题 HTML 文件是否位于 .chm 文件的根目录中。

例如,如果管理单元将 HTML 帮助文件 mysnapin.chm 合并到 MMC HTML 帮助文件和具有 htm/snphlp01.htm 内部帮助文件路径的主题 HTML 文件,则字符串将具有以下形式:

mysnapin.chm::htm/snphlp01.htm

此版本中不支持主题的数字 ID。

返回值

此回调函数可以返回其中一个值。

注解

MMCN_CONTEXTHELP通知的 通知处理程序中调用 MMCPropertyHelp。

管理单元可以在属性页上提供上下文帮助。 由于 MMC 属性表通常在单独的线程上运行,因此属性页不能直接使用 IDisplayHelp 接口。 相反,属性页可以从 MMC 库调用 MMCPropertyHelp 来实现相同的结果。 MMCPropertyHelp 采用与 IDisplayHelp::ShowTopic 相同的主题字符串参数,并处理将请求封送给main MMC 线程。

如果管理单元处理 MMCN_CONTEXTHELP 通知,MMC 希望管理单元为所选项目指定帮助主题。 因此,在 MMCN_CONTEXTHELP 通知的通知处理程序中,管理单元有两个选项:

  • 它可以调用 IDisplayHelp::ShowTopicMMCPropertyHelp 来指定帮助主题,然后返回 S_OK 以指示成功。 请注意,如果管理单元指定了帮助主题,则仅应返回 S_OK 。 如果管理单元在未指定帮助主题的情况下返回 S_OK ,则不会显示帮助主题。
  • 它可以向通知返回S_FALSE。 MMC 随后调出目录,其中选择了默认 MMC 主题。

要求

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

另请参阅

IDisplayHelp::ShowTopic

ISnapinHelp2::GetHelpTopic