ISnapinHelp：：GetHelpTopic 方法 (mmc.h)

發行項
08/24/2023

可讓嵌入式管理單元將其編譯的 HTML 說明檔新增至 MMC 說明集合檔案。

語法

HRESULT GetHelpTopic(
  [out] LPOLESTR *lpCompiledHelpFile
);

參數

[out] lpCompiledHelpFile

Null 終止 Unicode 字串位址的指標，其中包含嵌入式管理單元所編譯說明檔的路徑 (.chm) 。指定路徑時，將檔案放在任何地方，並指定完整路徑名稱。

傳回值

這個方法可以傳回其中一個值。

備註

MMC 會呼叫此方法的嵌入式管理單元實作，以取得嵌入式管理單元說明檔的位置。 MMC 會將所有嵌入式管理單元的 HTML 說明檔與 MMC 主控台 HTML 說明集合檔案合併。

檢視集合時，嵌入式管理單元說明檔的主題階層會出現在目錄。

藉由合併 HTML 說明檔，MMC 會建立單一整合的 HTML 說明目錄、索引和搜尋功能。當使用者 按一下主要 [ 說明] 功能表上的 [Microsoft Management Console 說明] 時，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;
}