IDisplayHelp::ShowTopic メソッド (mmc.h)
IDisplayHelp::ShowTopic メソッドは、マージされた MMC HTML ヘルプ ファイルに指定された HTML ヘルプ トピックを表示します。
構文
HRESULT ShowTopic(
[in] LPOLESTR pszHelpTopic
);
パラメーター
[in] pszHelpTopic
マージされた MMC HTML ヘルプ ファイルに表示するトピックを指定する NULL で終わる文字列へのポインター。 文字列の形式は次のとおりです。
helpfilename::topicfilename
ここで、helpfilename は、MMC が MMC HTML ヘルプ コレクション ファイルにマージしたスナップインの HTML ヘルプ ファイル (.chm) のファイル名です (これはファイル名のみであり、元の HTML ヘルプ ファイルへのパスではありません)、topicfilename はスナップインの .chm ファイル内のトピック ファイルへの内部パスです。 スナップインの HTML ヘルプ ファイルの作成者は、トピック HTML ファイルの内部ディレクトリ構造があるかどうか、またはすべてのトピック HTML ファイルが .chm ファイルのルートにあるかどうかを判断します。
スナップインは、 ISnapinHelp2::GetHelpTopic メソッドの実装における .chm ファイルについて MMC に通知します。
たとえば、スナップインで HTML ヘルプ ファイル mysnapin.chm が MMC HTML ヘルプ コレクション ファイルにマージされ、htm/help01.htm の内部ファイル パスを持つトピック HTML ファイルが含まれている場合、文字列の形式は次のようになります。
mysnapin.chm::htm/help01.htm
代わりに、help01.htm トピック ファイルが mysnapin.chm ヘルプ ファイルのルートにある場合、文字列の形式は次のようになります。
mysnapin.chm::/help01.htm
トピックの数値 ID のサポートは、バージョン 1.2 以前には含まれていません。
戻り値
このメソッドは、これらの値のいずれかを返すことができます。
解説
MMC バージョン 1.0 および 1.1 では、 PSzHelpTopic を COM API 関数 CoTaskMemAlloc で割り当て、MMC で文字列を解放する必要がありました。 これにより、パラメーター内の割り当てに関する COM 規則に違反し、呼び出し元 (スナップイン) によって割り当てと解放の両方が必要になります。 MMC 1.2 および MMC 2.0 では、 pszHelpTopic を CoTaskMemAlloc と共に割り当てる必要はなくなりました。 呼び出し元は、必要なメモリ管理を自由に使用できます。 呼び出し元が CoTaskMemAlloc を使用することを選択した場合は、 CoTaskMemFree を呼び出して文字列を解放する必要もあります。
スナップインは、IComponent::Notify メソッドでMMCN_CONTEXTHELP通知を処理し、IDisplayHelp::ShowTopic を呼び出すことで、選択したアイテムのコンテキスト ヘルプを提供できます。
プロパティ ページの場合、スナップインは IDisplayHelp::ShowTopic ではなく MMCPropertyHelp を呼び出す必要があります。 MMC プロパティ シートは通常、別のスレッドで実行されるため、プロパティ ページで IDisplayHelp インターフェイスを直接使用することはできません。 代わりに、プロパティ ページで MMC ライブラリから MMCPropertyHelp を呼び出して、同じ結果を得ることができます。 MMCPropertyHelp は IDisplayHelp::ShowTopic と同じトピック文字列パラメーターを受け取り、メイン MMC スレッドへの要求のマーシャリングを処理します。
スナップインが MMCN_CONTEXTHELP 通知を処理する場合、MMC はスナップインで選択したアイテムのヘルプ トピックを指定することを想定しています。 そのため、 MMCN_CONTEXTHELP 通知の通知ハンドラーでは、スナップインには次の 2 つのオプションがあります。
- IDisplayHelp::ShowTopic または MMCPropertyHelp を呼び出してヘルプ トピックを指定し、S_OKを返して成功を示すことができます。 スナップインは、ヘルプ トピックを指定している場合にのみ S_OK を返す必要があることに注意してください。 スナップインがヘルプ トピックを指定せずに S_OK を返した場合、ヘルプ トピックは表示されません。
- S_FALSEを通知に返すことができます。 MMC では、既定の MMC トピックが選択されたヘルプ コレクション ファイルが表示されます。
要件
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | mmc.h |
| [DLL] | Mmcndmgr.dll |