ISnapinHelp::GetHelpTopic メソッド (mmc.h)
スナップインがコンパイル済みの HTML ヘルプ ファイルを MMC ヘルプ コレクション ファイルに追加できるようにします。
構文
HRESULT GetHelpTopic(
[out] LPOLESTR *lpCompiledHelpFile
);
パラメーター
[out] lpCompiledHelpFile
スナップインのコンパイル済みヘルプ ファイル (.chm) のパスを含む null で終わる Unicode 文字列のアドレスへのポインター。 パスを指定するときは、ファイルを任意の場所に配置し、完全なパス名を指定します。
戻り値
このメソッドは、これらの値のいずれかを返すことができます。
解説
MMC は、スナップインのこのメソッドの実装を呼び出して、スナップインのヘルプ ファイルの場所を取得します。 MMC は、すべてのスナップインの HTML ヘルプ ファイルを MMC コンソールの HTML ヘルプ コレクション ファイルとマージします。
コレクションを表示すると、スナップインのヘルプ ファイルのトピック階層が目次に表示されます。
MMC は、HTML ヘルプ ファイルをマージすることで、統合された単一の HTML ヘルプ 目次、インデックス、検索機能を作成します。 ユーザーが [メイン ヘルプ] メニューの [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;
}
要件
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | mmc.h |