英語で読む

次の方法で共有


MLHtmlHelp 関数

[この関数は、Windows XP および Windows Server 2003 を通じて使用できます。 以降のバージョンの Windows では変更または使用できない場合があります。]

現在の UI 言語設定に対応するヘルプ ウィンドウを表示します。

構文

HWND MLHtmlHelp(
  _In_ HWND      hwndCaller,
  _In_ LPCTSTR   pszFile,
  _In_ UINT      uCommand,
  _In_ DWORD_PTR dwData,
  _In_ DWORD     dwCrossCodePage
);

パラメーター

hwndCaller [in]

型: HWND

この関数を呼び出す親ウィンドウへのハンドル。

pszFile [in]

型: LPCTSTR

コンパイル済みヘルプ (.chm) ファイルの完全修飾パスを含むバッファー、または指定したヘルプ ファイル内のトピック ファイルへのポインター。

uCommand [in]

型: UINT

完了するコマンド。 この関数は、 HH_DISPLAY_TOPICHH_DISPLAY_TEXT_POPUPのみを直接サポートします。 その他のコマンドの場合、 dwCrossCodePage 値なしで呼び出しが HtmlHelp に転送されます。

dwData [in]

種類: DWORD_PTR

uCommand パラメーターの値に基づいて必要なデータ。

dwCrossCodePage [in]

型: DWORD

CP_ACPなど、現在の UI 言語設定のコード ページを示す DWORD 値。

戻り値

型: HWND

指定した uCommand と結果に応じて、 MLHtmlHelp は次のいずれかまたは両方を返します。

  • ヘルプ ウィンドウのハンドル (hwnd)。
  • NULL。 場合によっては、 NULL はエラーを示します。それ以外の場合、 NULL はヘルプ ウィンドウがまだ作成されていないことを示します。

注釈

現在の言語のヘルプ ファイルのパスに問題が発生した場合、呼び出しは標準処理のために HtmlHelp に転送されます。

ヘルプ ウィンドウが閉じられると、所有者がデスクトップでない限り、フォーカスは所有者に戻ります。 hwndCaller がデスクトップの場合、オペレーティング システムによってフォーカスが返される場所が決定されます。

さらに、MLHtmlHelp がヘルプ ウィンドウから通知メッセージを送信する場合、ヘルプ ウィンドウ定義で通知メッセージの追跡を有効にしている限り、メッセージは hwndCaller に送信されます。

次の例では 、HH_DISPLAY_TOPIC コマンドを呼び出して Help.chm という名前のヘルプ ファイルを開き、 という名前 Mainwinのヘルプ ウィンドウにその既定のトピックを表示します。 通常、このコマンドで指定されているヘルプ ウィンドウは標準 の HTML ヘルプ ビューアーです

HWND hwnd = HtmlHelp(GetDesktopWindow(),
                     "c:\\Help.chm::/Intro.htm>Mainwin",
                     HH_DISPLAY_TOPIC,
                     NULL,
                     CP_ACP);

注意

この関数を使用する場合は、ホスティング実行可能ファイルのスタック サイズを少なくとも 100k に設定します。 定義されたスタック サイズが小さすぎると、HTML ヘルプを実行するために作成されたスレッドもこのスタック サイズで作成され、操作が失敗する可能性があります。 必要に応じて、リンク コマンド ラインから /STACK を削除し、実行可能ファイルの DEF ファイル内の STACK 設定を削除することもできます (この場合、既定のスタック サイズは 1 MB です)。 /Fnumber コンパイラ コマンドを使用してスタック サイズを設定することもできます (コンパイラはこれを /STACK としてリンカーに渡します)。

 

要件

要件
サポートされている最小のクライアント
Windows 2000 Professional、Windows XP [デスクトップ アプリのみ]
サポートされている最小のサーバー
Windows Server 2003 [デスクトップ アプリのみ]
ヘッダー
なし
[DLL]
Shlwapi.dll (バージョン 5.0 以降)
Unicode 名と ANSI 名
MLHtmlHelpW (Unicode) と MLHtmlHelpA (ANSI)