MLWinHelp 関数
[この関数は、Windows XP と Windows Server 2003 経由で使用できます。 Windows のそれ以降のバージョンでは、変更されるか、使用できなくなる場合があります。]
Windows ヘルプ (Winhelp.exe) を起動し、アプリケーションで要求されたヘルプの性質を示す追加データを渡します。
BOOL MLWinHelp(
_In_ HWND hWndMain,
_In_ LPCTSTR lpszHelp,
_In_ UINT uCommand,
_In_ DWORD_PTR dwData
);
-
hWndMain [in]
-
型: HWND
ヘルプを要求するウィンドウへのハンドル。 MLWinHelp 関数は、このハンドルを使用して、どのアプリケーションがヘルプを要求しているかを追跡し続けます。 uCommand パラメーターが HELP_CONTEXTMENU または HELP_WM_HELP を指定する場合、hWndMain はヘルプを要求するコントロールを特定します。
-
lpszHelp [in]
-
型: LPCTSTR
必要に応じて、パスを含む null で終わる文字列のアドレスと、MLWinHelp で表示されるヘルプ ファイルの名前。
トピックをプライマリ ウィンドウではなくセカンダリ ウィンドウに表示する場合は、ファイル名の後に山かっこ (>) とセカンダリ ウィンドウの名前を付けることができます。 ヘルプ プロジェクト (.hpj) ファイルの [WINDOWS] セクションで、セカンダリ ウィンドウの名前を定義する必要があります。
-
uCommand [in]
-
型: UINT
要求されるヘルプの種類です。 可能な値の一覧と、dwData パラメーターに配置する値に与える影響については、「解説」セクションを参照してください。
-
dwData [in]
-
型: DWORD_PTR
追加データ。 使用される値は、uCommand パラメーターの値によって異なります。 使用可能な dwData 値の一覧については、「解説」セクションを参照してください。
型: BOOL
成功した場合は 0 以外の値、それ以外の場合は 0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
この関数はヘッダー ファイルに含まれていないため、MLWinHelpA の場合は序数 395、MLWinHelpW の場合は 397 で呼び出す必要があります。
MLWinHelp は基本的に WinHelp のラッパーです。 WinHelp を呼び出す前に、現在の UI 言語設定に対応するヘルプ ファイルへのパスを取得しようとします。 成功した場合は、そのパスを渡します。 失敗した場合は、lpszHelp でポイントされるパスを渡します。
現在のユーザー以外のコンテキストから呼び出された場合、この関数は失敗します。
ヘルプを要求したウィンドウを閉じる前に、アプリケーションは uCommand パラメーターを HELP_QUIT に設定して MLWinHelp を呼び出す必要があります。 すべてのアプリケーションでこれを行うまで、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 | コンテンツ トピックを指定します。 Windows ヘルプでは、ヘルプ ファイルに .cnt ファイルが関連付けられていない場合にユーザーが [コンテンツ] ボタンをクリックすると、このトピックが表示されます。 | コンテンツ トピックのコンテキスト識別子が含まれます。 |
HELP_SETPOPUP_POS | 後続のポップアップ ウィンドウの位置を設定します。 | 位置データを格納します。 MAKELONG マクロを使用して、水平方向と垂直方向の座標を 1 つの値に連結します。 ポップアップ ウィンドウは、ポップアップ ウィンドウが呼び出された場合に、マウス カーソルが指定した位置にあるかのように配置されます。 |
HELP_SETWINPOS | Windows ヘルプ ウィンドウが最小化またはメモリ内にある場合は表示し、指定したサイズと位置を設定します。 | プライマリ ヘルプ ウィンドウまたはセカンダリ ヘルプ ウィンドウのサイズと位置を指定する HELPWININFO 構造体のアドレス。 |
HELP_TCARD | コマンドが Windows ヘルプのトレーニング カード インスタンス用であることを示します。 ビットごとの OR 演算子を使用して、このコマンドを他のコマンドと組み合わせます。 | このコマンドを組み合わせるコマンドによって異なります。 |
HELP_WM_HELP | ポップアップ ウィンドウで hWndMain パラメーターによって識別されるコントロールのトピックを表示します。 | DWORD ペアの配列のアドレス。 各ペアの最初の DWORD はコントロール識別子で、2 番目はトピックのコンテキスト識別子です。 配列は 0 {0,0} のペアで終了する必要があります。 特定のコントロールにヘルプを追加しない場合は、そのコンテキスト識別子を -1 に設定します。 |
要件 | Value |
---|---|
サポートされている最小のクライアント |
Windows 2000 Professional、Windows XP [デスクトップ アプリのみ] |
サポートされている最小のサーバー |
Windows Server 2003 (デスクトップ アプリのみ) |
ヘッダー |
|
[DLL] |
|
Unicode 名と ANSI 名 |
MLWinHelpW (Unicode) と MLWinHelpA (ANSI) |