WinHelpA 関数 (winuser.h)

Windows ヘルプ (Winhelp.exe) を起動し、アプリケーションによって要求されたヘルプの性質を示す追加データを渡します。

構文

BOOL WinHelpA(
  HWND      hWndMain,
  LPCSTR    lpszHelp,
  UINT      uCommand,
  ULONG_PTR dwData
);

パラメーター

hWndMain

型: HWND

ヘルプを要求するウィンドウへのハンドル。 WinHelp 関数は、このハンドルを使用して、ヘルプを要求したアプリケーションを追跡します。 uCommand パラメーターがHELP_CONTEXTMENUまたはHELP_WM_HELPを指定している場合、hWndMain はヘルプを要求するコントロールを識別します。

lpszHelp

型: LPCTSTR

必要に応じて、パスと WinHelp が表示するヘルプ ファイルの名前を含む null で終わる文字列のアドレス。

トピックをプライマリ ウィンドウではなくセカンダリ ウィンドウに表示する場合は、ファイル名の後に山かっこ (>) とセカンダリ ウィンドウの名前を付けることができます。 セカンダリ ウィンドウの名前は、ヘルプ プロジェクト (.hpj) ファイルの [WINDOWS] セクションで定義する必要があります。

uCommand

型: UINT

要求されたヘルプの種類。 可能な値の一覧と、 dwData パラメーターに配置する値に与える影響については、「解説」セクションを参照してください。

dwData

種類: ULONG_PTR

その他のデータ。 使用される値は、 uCommand パラメーターの値によって異なります。 可能な dwData 値の一覧については、「解説」セクションを参照してください。

戻り値

種類: BOOL

成功した場合は 0 以外、それ以外の場合は 0 を返します。 拡張エラー情報を取得するには、 GetLastError を呼び出します。

注釈

ヘルプを要求したウィンドウを閉じる前に、アプリケーションは uCommand パラメーターを HELP_QUIT に設定して WinHelp を呼び出す必要があります。 すべてのアプリケーションでこれを行うまで、Windows ヘルプは終了しません。 HELP_CONTEXTPOPUP コマンドを使用して Windows ヘルプを起動した場合、HELP_QUIT コマンドで Windows ヘルプを呼び出す必要はありません。

この関数は、現在のユーザー以外のコンテキストから呼び出された場合に失敗します。

次の表は、 uCommand パラメーターに使用できる値と dwData パラメーターの対応する形式を示しています。

要件

こちらもご覧ください

HELPWININFO

MULTIKEYHELP