htmlHelpA 函式 (htmlhelp.h)

顯示說明視窗。

使用 API 命令，您可以指定要顯示在說明視窗中的主題、說明視窗是三窗格說明查看器或彈出視窗，以及 HTML 主題檔案是否應該透過內容識別碼、 HTML 說明 URL 或關鍵詞連結來存取 (KLink) 查閱。

語法

HWND HtmlHelpA(
  [in, optional] HWND      hwndCaller,
  [in]           LPCSTR    pszFile,
  [in]           UINT      uCommand,
  [in]           DWORD_PTR dwData
);

參數

[in, optional] hwndCaller

指定呼叫 HtmlHelp 之視窗 (hwnd) 句柄。 說明視窗是由這個視窗所擁有。

關閉說明視窗時，除非擁有者是桌面， 否則 HtmlHelp 會將焦點返回擁有者。 如果 hwndCaller 是桌面電腦，則操作系統會決定傳回焦點的位置。

此外，如果 HtmlHelp 從說明視窗傳送任何通知訊息，只要您已在說明視窗定義中啟用通知訊息追蹤，就會將它們傳送至 hwndCaller。

[in] pszFile

根據 uCommand 值，指定已編譯說明 (.chm) 檔案的 檔案路徑 ，或指定說明檔內的主題檔案。

您也可以指定 視窗類型 名稱，前面加上大於 () > 字元。

如果指定的命令不需要檔案，這個值可能是 NULL。

[in] uCommand

指定要完成的 命令 。

[in] dwData

根據 uCommand 參數的值，指定可能需要的任何數據。

傳回值

根據指定的 uCommand 和結果， HtmlHelp 會傳回下列其中一項或兩者：

• 說明視窗的句柄 (hwnd) 。
• NULL. 在某些情況下，NULL 表示失敗;在其他情況下，NULL 表示尚未建立說明視窗。

備註

語法適用於 ANSI 字元集。 使用 Unicode 字元集時， pszFile 參數的類型應該是 “LPCTSTR”。

使用 HTML 說明 API 時，請將裝載可執行檔的堆疊大小設定為至少 100k。 如果定義的堆疊大小太小，則建立以執行 HTML 說明的線程也會以此堆疊大小建立，而且可能會造成失敗。 您可以選擇性地從連結命令行移除 /STACK，並在可執行檔的 DEF 檔案中移除任何 STACK 設定， (預設堆疊大小為 1 MB，在此情況下) 。 您也可以使用 /Fnumber 編譯程式命令來設定堆棧大小， (編譯程式會將此專案傳遞至鏈接器作為 /STACK) 。

範例

下列範例會呼叫 HH_DISPLAY_TOPIC 命令，以開啟名為 Help.chm 的說明檔，並在名為 Mainwin 的說明視窗中顯示其預設主題。 一般而言，此命令中指定的說明視窗是標準 HTML 說明查看器。

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

注意

htmlhelp.h 標頭會將 HtmlHelp 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求	值
目標平台	Windows
標頭	htmlhelp.h
程式庫	Htmlhelp.lib
Dll	hhctrl.ocx

另請參閱

關於 HTML 說明 API