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 パラメーターの対応する形式を示しています。
| uCommand | アクション | dwData |
|---|---|---|
| HELP_COMMAND | ヘルプ マクロまたはマクロ文字列を実行します。 | 実行するヘルプ マクロの名前を指定する文字列のアドレス。 文字列で複数のマクロ名を指定する場合は、名前をセミコロンで区切る必要があります。 Windows ヘルプでは長い名前がサポートされていないため、一部のマクロには短い形式のマクロ名を使用する必要があります。 |
| HELP_CONTENTS | .hpj ファイルの [OPTIONS] セクションの [コンテンツ] オプションで指定されたトピックを表示します。 このコマンドは、下位互換性を確保するためのコマンドです。 新しいアプリケーションでは、.cnt ファイルを指定し、HELP_FINDER コマンドを使用する必要があります。 | 無視;を 0 に設定します。 |
| HELP_CONTEXT | .hpj ファイルの [MAP] セクションで定義されている、指定されたコンテキスト識別子によって識別されるトピックを表示します。 | トピックのコンテキスト識別子を格納します。 |
| HELP_CONTEXTMENU | 選択したウィンドウの [ヘルプ ] メニューを表示し、選択したコントロールのトピックをポップアップ ウィンドウに表示します。 | DWORD ペアの配列のアドレス。 各ペアの最初の DWORD はコントロール識別子で、2 番目の DWORD はトピックのコンテキスト識別子です。 配列は、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 | 指定したキーワード (keyword)に一致するトピックが完全に一致する場合は、キーワード (keyword) テーブルに表示されます。 一致するものが複数ある場合は、[トピックが 見つかりました ] リスト ボックスに一覧表示されているトピックを含む [インデックス] を表示します。 | キーワード (keyword)文字列のアドレス。 複数のキーワードはセミコロンで区切る必要があります。 |
| HELP_MULTIKEY | キーワード (keyword)で指定されたトピックを別のキーワード (keyword)テーブルに表示します。 | 表の脚注文字とキーワード (keyword)を指定する MULTIKEYHELP 構造体のアドレス。 |
| HELP_PARTIALKEY | 指定したキーワード (keyword)に一致するトピックが完全に一致する場合は、キーワード (keyword) テーブルに表示されます。 一致するものが複数ある場合は、[トピックが 見つかりました ] ダイアログ ボックスが表示されます。 キーワード (keyword)を渡さずにインデックスを表示するには、空の文字列へのポインターを使用します。 | キーワード (keyword)文字列のアドレス。 複数のキーワードはセミコロンで区切る必要があります。 |
| HELP_QUIT | 不要になったことを Windows ヘルプに通知します。 他のアプリケーションがヘルプを求めていない場合、Windows は Windows ヘルプを閉じます。 | 無視;を 0 に設定します。 |
| HELP_SETCONTENTS | Contents トピックを指定します。 Windows ヘルプでは、ヘルプ ファイルに .cnt ファイルが関連付けられていない場合にユーザーが [ コンテンツ ] ボタンをクリックすると、このトピックが表示されます。 | Contents トピックのコンテキスト識別子を格納します。 |
| HELP_SETPOPUP_POS | 後続のポップアップ ウィンドウの位置を設定します。 | 位置データを格納します。 MAKELONG を使用して、水平方向と垂直方向の座標を 1 つの値に連結します。 ポップアップ ウィンドウは、ポップアップ ウィンドウが呼び出されたときに、マウス カーソルが指定したポイントにあるかのように配置されます。 |
| HELP_SETWINPOS | Windows ヘルプ ウィンドウが最小化されている場合、またはメモリ内に表示され、指定したサイズと位置が設定されます。 | プライマリ ヘルプ ウィンドウまたはセカンダリ ヘルプ ウィンドウのサイズと位置を指定する HELPWININFO 構造体のアドレス。 |
| HELP_TCARD | コマンドが Windows ヘルプのトレーニング カード インスタンス用であることを示します。 ビットごとの OR 演算子を使用して、このコマンドを他のコマンドと組み合わせます。 | このコマンドを組み合わせるコマンドによって異なります。 |
| HELP_WM_HELP | ポップアップ ウィンドウで hWndMain パラメーターによって識別されるコントロールのトピックを表示します。 | DWORD ペアの配列のアドレス。 各ペアの最初の DWORD はコントロール識別子で、2 番目の DWORD はトピックのコンテキスト識別子です。 配列は、0 のペアで終了する {0,0}必要があります。 特定のコントロールにヘルプを追加しない場合は、そのコンテキスト識別子を -1 に設定します。 |
注意
winuser.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして WinHelp を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| 対象プラットフォーム | Windows |
| ヘッダー | winuser.h |
| Library | User32.lib |
| [DLL] | User32.dll |
| API セット | ext-ms-win-ntuser-misc-l1-5-1 (Windows 10 バージョン 10.0.14393 で導入) |