WinHelpA 関数 (winuser.h)

[アーティクル]
11/20/2024

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

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

トピックをプライマリウィンドウではなくセカンダリウィンドウに表示する場合は、ファイル名の後に山かっこ (>) とセカンダリウィンドウの名前を付けることができます。ヘルププロジェクト (.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 パラメーターの対応する形式を示します。

uCommand をする	アクション	dwData をする
HELP_COMMAND	ヘルプマクロまたはマクロ文字列を実行します。	実行するヘルプマクロの名前を指定する文字列のアドレス。文字列で複数のマクロ名を指定する場合、名前はセミコロンで区切る必要があります。 Windows ヘルプでは長い名前がサポートされていないため、一部のマクロには短い形式のマクロ名を使用する必要があります。
HELP_CONTENTS	.hpj ファイルの [OPTIONS] セクションの [コンテンツ] オプションで指定されたトピックを表示します。このコマンドは旧バージョンとの互換性を維持するために使用します。新しいアプリケーションで .cnt ファイルを提供し、HELP_FINDER コマンドを使用する必要があります。	無視;0 に設定します。
HELP_CONTEXT	.hpj ファイルの [MAP] セクションで定義されている、指定されたコンテキスト識別子によって識別されるトピックを表示します。	トピックのコンテキスト識別子を格納します。
HELP_CONTEXTMENU	選択したウィンドウのヘルプメニューを表示し、選択したコントロールのトピックをポップアップウィンドウに表示します。	DWORD ペアの配列のアドレス。各ペアの最初の DWORD はコントロール識別子、2 つ目はトピックのコンテキスト識別子です。配列は、{0,0}0 のペアで終了する必要があります。特定のコントロールにヘルプを追加しない場合は、そのコンテキスト識別子を -1 に設定します。
HELP_CONTEXTPOPUP	ポップアップウィンドウの .hpj ファイルの [MAP] セクションで定義されている、指定されたコンテキスト識別子によって識別されるトピックを表示します。	トピックのコンテキスト識別子を格納します。
HELP_FINDER	[ヘルプトピック] ダイアログボックスを表示します。	無視;0 に設定します。
HELP_FORCEFILE	Windows ヘルプに正しいヘルプファイルが表示されていることを確認します。正しくないヘルプファイルが表示されている場合は、Windows ヘルプで正しいヘルプが開きます。それ以外の場合は、アクションはありません。	無視;0 に設定します。
HELP_HELPONHELP	Winhlp32.hlp ファイルが使用可能な場合は、Windows ヘルプの使用方法に関するヘルプが表示されます。	無視;0 に設定します。
HELP_INDEX	.hpj ファイルの [OPTIONS] セクションの [コンテンツ] オプションで指定されたトピックを表示します。このコマンドは旧バージョンとの互換性を維持するために使用します。新しいアプリケーションでは、HELP_FINDER コマンドを使用する必要があります。	無視;0 に設定します。
HELP_KEY	完全一致がある場合は、指定したキーワードと一致するトピックをキーワードテーブルに表示します。一致するトピックが複数ある場合は、[トピックが見つかりました] リストボックスに一覧表示されたインデックス表示されます。	キーワード文字列のアドレス。複数のキーワードはセミコロンで区切る必要があります。
HELP_MULTIKEY	代替キーワードテーブル内のキーワードで指定されたトピックを表示します。	テーブル脚注文字とキーワードを指定する MULTIKEYHELP 構造体のアドレス。
HELP_PARTIALKEY	完全一致がある場合は、指定したキーワードと一致するトピックをキーワードテーブルに表示します。一致するものが複数ある場合は、[トピックが見つかった ] ダイアログボックスが表示されます。キーワードを渡さずにインデックスを表示するには、空の文字列へのポインターを使用します。	キーワード文字列のアドレス。複数のキーワードはセミコロンで区切る必要があります。
HELP_QUIT	不要になったことを Windows ヘルプに通知します。他のアプリケーションがヘルプを求めていない場合、Windows は Windows ヘルプを閉じます。	無視;0 に設定します。
HELP_SETCONTENTS	コンテンツトピックを指定します。ヘルプファイルに .cnt ファイルが関連付けられていない場合、ユーザーが [コンテンツ] ボタンをクリックすると、Windows ヘルプにこのトピックが表示されます。	Contents トピックのコンテキスト識別子を格納します。
HELP_SETPOPUP_POS	後続のポップアップウィンドウの位置を設定します。	位置データを格納します。 MAKELONG 使用して、水平方向と垂直方向の座標を 1 つの値に連結します。ポップアップウィンドウは、ポップアップウィンドウが呼び出されたときに、マウスカーソルが指定した位置にあるかのように配置されます。
HELP_SETWINPOS	最小化またはメモリ内にある場合は、Windows ヘルプウィンドウを表示し、指定したサイズと位置を設定します。	プライマリヘルプウィンドウまたはセカンダリヘルプウィンドウのサイズと位置を指定する HELPWININFO 構造体のアドレス。
HELP_TCARD	コマンドが Windows ヘルプのトレーニングカードインスタンス用であることを示します。ビットごとの OR 演算子を使用して、このコマンドを他のコマンドと組み合わせます。	このコマンドを組み合わせるコマンドによって異なります。
HELP_WM_HELP	ポップアップウィンドウで、hWndMain パラメーターによって識別されるコントロールのトピックを表示します。	DWORD ペアの配列のアドレス。各ペアの最初の DWORD はコントロール識別子で、2 つ目はトピックのコンテキスト識別子です。配列は、{0,0}0 のペアで終了する必要があります。特定のコントロールにヘルプを追加しない場合は、そのコンテキスト識別子を -1 に設定します。

手記

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

必要条件

要件	価値
サポートされる最小クライアント	Windows XP [デスクトップアプリのみ]
サポートされる最小サーバー	Windows 2000 Server [デスクトップアプリのみ]
ターゲットプラットフォームの	ウィンドウズ
ヘッダー	winuser.h
ライブラリ	User32.lib
DLL	User32.dll
API セットの	ext-ms-win-ntuser-misc-l1-5-1 (Windows 10 バージョン 10.0.14393 で導入)

次の方法で共有

WinHelpA 関数 (winuser.h)

構文

パラメーター

戻り値

備考

必要条件

関連項目

フィードバック

その他のリソース