MMCPropertyHelp 関数 (mmc.h)

MMCPropertyHelp 関数は、MMC 1.1 で導入されています。

MMCPropertyHelp 関数は、プロパティ ページのマージされた MMC HTML ヘルプ ファイルに、指定された HTML ヘルプ トピックを表示します。

構文

HRESULT MMCPropertyHelp(
  LPOLESTR pszHelpTopic
);

パラメーター

pszHelpTopic

マージされた MMC HTML ヘルプ ファイルに表示するトピックを指定する NULL で終わる文字列へのポインター。 文字列の形式は次のとおりです。

helpfilename::topicfilename

helpfilename は、MMC が MMC HTML ヘルプ ファイルにマージしたスナップインの HTML ヘルプ ファイル (.chm) のファイル名 (元の 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 と同じトピック文字列パラメーターを受け取り、メイン MMC スレッドへの要求のマーシャリングを処理します。

スナップインが MMCN_CONTEXTHELP 通知を処理する場合、MMC はスナップインで選択したアイテムのヘルプ トピックを指定することを想定しています。 そのため、 MMCN_CONTEXTHELP 通知の通知ハンドラーでは、スナップインには次の 2 つのオプションがあります。

• IDisplayHelp::ShowTopic または MMCPropertyHelp を呼び出してヘルプ トピックを指定し、S_OKを返して成功を示すことができます。 スナップインは、ヘルプ トピックを指定している場合にのみ S_OK を返す必要があることに注意してください。 スナップインがヘルプ トピックを指定せずに S_OK を返した場合、ヘルプ トピックは表示されません。
• S_FALSEを通知に返すことができます。 MMC によって、既定の MMC トピックが選択された目次が表示されます。

要件

関連項目

IDisplayHelp::ShowTopic

ISnapinHelp2::GetHelpTopic