ISnapinHelp：：GetHelpTopic 方法 (mmc.h)

项目
08/24/2023

允许管理单元将其编译的 HTML 帮助文件添加到 MMC 帮助集合文件。

语法

HRESULT GetHelpTopic(
  [out] LPOLESTR *lpCompiledHelpFile
);

parameters

[out] lpCompiledHelpFile

指向以 null 结尾的 Unicode 字符串的地址的指针，该字符串包含管理单元的已编译帮助文件 (.chm) 的路径。指定路径时，将文件放在任意位置并指定完整路径名称。

返回值

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

注解

MMC 调用管理单元的此方法的实现，以获取管理单元的帮助文件的位置。 MMC 将所有管理单元的 HTML 帮助文件与 MMC 控制台 HTML 帮助收集文件合并。

查看集合时，管理单元的“帮助”文件中的主题层次结构将显示在目录中。

通过合并 HTML 帮助文件，MMC 创建一个集成的 HTML 帮助目录、索引和搜索功能。当用户在“main帮助”菜单上单击 Microsoft 管理控制台上的“帮助”时，MMC 将打开合并的帮助文件，其中包含当前控制台文件中所有管理单元的 HTML 帮助文件。

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

示例

STDMETHODIMP CComponentData::GetHelpTopic( LPOLESTR *lpCompiledFile )
{
    LPOLESTR lpHelpFile;
 
    if ( !lpCompiledFile )
        return E_POINTER; // invalid argument
 
    lpHelpFile = (LPOLESTR) CoTaskMemAlloc( MAX_PATH * sizeof(WCHAR) );
 
    if ( !lpHelpFile )
    {
        return E_OUTOFMEMORY;
    }
 
    ExpandEnvironmentStringsW( L"%SystemRoot%\\Help\\myhelpfile.chm", lpHelpFile, MAX_PATH );
 
    *lpCompiledHelpFile = lpHelpFile;
 
    return S_OK;
}