ISnapinHelp

スナップインが HTML ヘルプのサポートを追加できるようにします。(ISnapinHelp)

スナップインが、コンパイル済みの HTML ヘルプファイルを MMC のヘルプコレクションファイルに追加できるようにします。

このメソッドは、次のいずれかの値を返すことがあります。

MMC は、スナップインのヘルプファイルの場所を取得するために、このメソッドのスナップイン側の実装を呼び出します。MMC は、すべてのスナップインの HTML ヘルプファイルを MMC コンソールの HTML ヘルプコレクションファイルにマージします。

コレクションを表示すると、スナップインのヘルプファイルのトピック階層が目次に表示されます。

HTML ヘルプファイルをマージすることで、MMC は単一の統合された HTML ヘルプの目次、インデックス、および検索機能を作成します。ユーザーがメインの ヘルプ メニューで [Microsoft Management Console のヘルプ] をクリックすると、MMC は現在のコンソールファイル内のすべてのスナップインの HTML ヘルプファイルを含む、マージ済みのヘルプファイルを開きます。

lpCompiledHelpFile 文字列は、COM API 関数 CoTaskMemAlloc(またはそれと同等のもの)で割り当ててください。解放は 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;
}