HtmlHelpA 関数 (htmlhelp.h)

ヘルプ ウィンドウを表示します。

API コマンドを使用すると、ヘルプ ウィンドウに表示するトピック、ヘルプ ウィンドウが 3 ペインのヘルプ ビューアーかポップアップ ウィンドウか、コンテキスト ID、 HTML ヘルプ URL、キーワード リンク (KLink) 参照を使用して HTML トピック ファイルにアクセスするかを指定できます。

構文

HWND HtmlHelpA(
  [in, optional] HWND      hwndCaller,
  [in]           LPCSTR    pszFile,
  [in]           UINT      uCommand,
  [in]           DWORD_PTR dwData
);

パラメーター

[in, optional] hwndCaller

HtmlHelp を呼び出すウィンドウのハンドル (hwnd) を指定します。 ヘルプ ウィンドウは、このウィンドウによって所有されています。

ヘルプ ウィンドウが閉じられると、所有者がデスクトップでない限り、 HtmlHelp は所有者にフォーカスを返します。 hwndCaller がデスクトップの場合、オペレーティング システムによってフォーカスが返される場所が決定されます。

また、HtmlHelp がヘルプ ウィンドウから通知メッセージを送信する場合は、ヘルプ ウィンドウ定義で通知メッセージの追跡を有効にしている限り、そのメッセージは hwndCaller に送信されます。

[in] pszFile

uCommand 値に応じて、コンパイル済みヘルプ (.chm) ファイルまたは指定されたヘルプ ファイル内のトピック ファイルへのファイル パスを指定します。

ウィンドウの種類名の前に大きい (>) 文字を付けることもできます。

指定したコマンドにファイルが必要ない場合、この値は NULL である可能性があります。

[in] uCommand

完了するコマンドを指定 します 。

[in] dwData

uCommand パラメーターの値に基づいて、必要なデータを指定します。

戻り値

指定した uCommand と結果に応じて、 HtmlHelp は 次のいずれかまたは両方を返します。

• ヘルプ ウィンドウのハンドル (hwnd)。
• NULL. 場合によっては、NULL はエラーを示します。それ以外の場合、NULL はヘルプ ウィンドウがまだ作成されていないことを示します。

注釈

構文は ANSI 文字セットに適用されます。 Unicode 文字セットを使用する場合、 pszFile パラメーターの型は "LPCTSTR" である必要があります。

HTML ヘルプ API を使用する場合は、ホスティング実行可能ファイルのスタック サイズを少なくとも 100k に設定します。 定義されたスタック サイズが小さすぎると、HTML ヘルプを実行するために作成されたスレッドもこのスタック サイズで作成され、エラーが発生する可能性があります。 必要に応じて、リンク コマンド ラインから /STACK を削除し、実行可能ファイルの DEF ファイル内の STACK 設定を削除できます (この場合、既定のスタック サイズは 1 MB です)。 /Fnumber コンパイラ コマンドを使用してスタック サイズを設定することもできます (コンパイラはこれを /STACK としてリンカーに渡します)。

例

次の例では 、HH_DISPLAY_TOPIC コマンドを呼び出して Help.chm という名前のヘルプ ファイルを開き、Mainwin という名前のヘルプ ウィンドウにその既定のトピックを表示します。 通常、このコマンドで指定されたヘルプ ウィンドウは標準 の HTML ヘルプ ビューアーです。

HWND hwnd =
   HtmlHelp(
            GetDesktopWindow(),
            "c:\\Help.chm::/Intro.htm>Mainwin",
            HH_DISPLAY_TOPIC,
            NULL) ;

注意

htmlhelp.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして HtmlHelp を定義します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件	値
対象プラットフォーム	Windows
ヘッダー	htmlhelp.h
Library	Htmlhelp.lib
[DLL]	hhctrl.ocx

こちらもご覧ください

HTML ヘルプ API について