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 を使用する場合は、ホスティング実行可能ファイルのスタック サイズを少なくとも 100,000 に設定します。 定義されたスタック サイズが小さすぎると、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) ;

必要条件

関連項目

HTML ヘルプ API について