winHelpW 函式 (winuser.h)
啟動 Windows 說明 (Winhelp.exe) 並傳遞其他資料,指出應用程式所要求的說明本質。
語法
BOOL WinHelpW(
HWND hWndMain,
LPCWSTR lpszHelp,
UINT uCommand,
ULONG_PTR dwData
);
參數
hWndMain
類型: HWND
要求說明之視窗的控制碼。 WinHelp函式會使用此控制碼來追蹤哪些應用程式已要求協助。 如果 uCommand 參數指定 HELP_CONTEXTMENU 或 HELP_WM_HELP, hWndMain 會識別要求說明的控制項。
lpszHelp
類型: LPCTSTR
如有需要,包含路徑的 Null 終止字串位址,以及 WinHelp 要顯示的說明檔名稱。
檔案名後面可以加上角括弧 (>) ,如果主題要顯示在次要視窗中,而不是在主要視窗中顯示,則為次要視窗的名稱。 您必須在 [說明] 專案的 [WINDOWS] 區段中定義次要視窗的名稱, (.hpj) 檔案。
uCommand
類型: UINT
所要求的說明類型。 如需可能值的清單,以及它們如何影響 dwData 參數中放置的值,請參閱一節。
dwData
類型: ULONG_PTR
其他資料。 所使用的值取決於 uCommand 參數的值。 如需可能的 dwData 值清單,請參閱一節。
傳回值
類型: BOOL
如果成功,則傳回非零,否則傳回零。 若要擷取擴充的錯誤資訊,請呼叫 GetLastError。
備註
關閉要求說明的視窗之前,應用程式必須呼叫 WinHelp , 並將 uCommand 參數設定為 HELP_QUIT。 在完成所有應用程式之前,Windows 說明將不會終止。 請注意,如果您使用 HELP_CONTEXTPOPUP 命令來啟動 Windows 說明,則不需要使用 HELP_QUIT 命令呼叫 Windows 說明。
如果從任何內容呼叫但目前使用者,此函式會失敗。
下表顯示 uCommand 參數的可能值,以及 dwData 參數的對應格式。
uCommand | 動作 | dwData |
---|---|---|
HELP_COMMAND | 執行 Help 宏或宏字串。 | 字串的位址,指定要執行之說明宏的名稱 () 。 如果字串指定多個宏名稱,則名稱必須以分號分隔。 您必須針對某些宏使用宏名稱的簡短形式,因為 Windows 說明不支援長名稱。 |
HELP_CONTENTS | 在 .hpj 檔案的 [OPTIONS] 區段中顯示 Contents 選項所指定的主題。 此命令適用于回溯相容性。 新的應用程式應該提供 .cnt 檔案,並使用 HELP_FINDER 命令。 | 忽視;設定為 0。 |
HELP_CONTEXT | 顯示由 .hpj 檔案 [MAP] 區段中所定義之指定內容識別碼所識別的主題。 | 包含主題的內容識別碼。 |
HELP_CONTEXTMENU | 顯示所選視窗的 [ 說明 ] 功能表,然後在快顯視窗中顯示所選控制項的主題。 | DWORD配對陣列的位址。 每個配對中的第一個 DWORD 是控制項識別碼,第二個則是主題的內容識別碼。 陣列必須以一對零 {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] 區段中顯示 Contents 選項所指定的主題。 此命令適用于回溯相容性。 新的應用程式應該使用 HELP_FINDER 命令。 | 忽視;設定為 0。 |
HELP_KEY | 如果完全相符,則會在關鍵字資料表中顯示符合指定關鍵字的主題。 如果有一個以上的相符專案,會顯示 [索引],其中包含 [ 找到的主題 ] 清單方塊中所列的主題。 | 關鍵字字串的位址。 多個關鍵字必須以分號分隔。 |
HELP_MULTIKEY | 在替代關鍵字資料表中顯示關鍵字所指定的主題。 | 指定表格註腳字元和關鍵字之 MULTIKEYHELP 結構的位址。 |
HELP_PARTIALKEY | 如果完全相符,則會在關鍵字資料表中顯示符合指定關鍵字的主題。 如果有一個以上的相符專案,會顯示 [ 找到主題 ] 對話方塊。 若要顯示索引而不傳遞關鍵字,請使用空字串的指標。 | 關鍵字字串的位址。 多個關鍵字必須以分號分隔。 |
HELP_QUIT | 通知 Windows 說明,不再需要它。 如果沒有其他應用程式要求協助,Windows 會關閉 Windows 說明。 | 忽視;設定為 0。 |
HELP_SETCONTENTS | 指定 Contents 主題。 如果使用者按一下 [ 內容 ] 按鈕,則 Windows 說明會在說明檔沒有相關聯的 .cnt 檔案時顯示本主題。 | 包含 Contents 主題的內容識別碼。 |
HELP_SETPOPUP_POS | 設定後續快顯視窗的位置。 | 包含位置資料。 使用 MAKELONG 將水準和垂直座標串連成單一值。 快顯視窗的位置就像是滑鼠游標在叫用快顯視窗時所指定的點一樣。 |
HELP_SETWINPOS | 如果視窗最小化或記憶體中,則會顯示 Windows 說明視窗,並依照指定設定其大小和位置。 | HELPWININFO結構的位址,指定主要或次要說明視窗的大小和位置。 |
HELP_TCARD | 指出命令適用于 Windows 說明的定型卡片實例。 使用位 OR 運算子,將此命令與其他命令結合。 | 取決於結合此命令的命令。 |
HELP_WM_HELP | 顯示快顯視窗中 hWndMain 參數所識別之控制項的主題。 | DWORD配對陣列的位址。 每個配對中的第一個 DWORD 是控制項識別碼,第二個是主題的內容識別碼。 陣列必須以一對零 {0,0} 終止。 如果您不想將 [說明] 新增至特定控制項,請將其內容識別碼設定為 -1。 |
注意
winuser.h 標頭會將 WinHelp 定義為別名,根據 UNICODE 預處理器常數的定義,自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程式碼,可能會導致編譯或執行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
最低支援的伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | winuser.h |
程式庫 | User32.lib |
Dll | User32.dll |
API 集合 | ext-ms-win-ntuser-misc-l1-5-1 (Windows 10 10.0.14393 版) |