MLWinHelp 函式

[此函式可透過 Windows XP 和 Windows Server 2003 取得。 它可能會在後續版本的 Windows 中改變或無法使用。]

啟動 Windows Help （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

傳回成功時的非零值，否則傳回零。 若要取得擴充的錯誤資訊，請呼叫 GetLastError。

備註

此函式不包含在頭檔中，而且必須針對 MLWinHelpA 呼叫序數 395，MLWinHelpW 必須呼叫 397。

MLWinHelp 基本上是 WinHelp 的包裝函式。 它會在呼叫 WinHelp 之前，嘗試取得對應至目前 UI 語言設定的說明檔路徑。 如果成功，則會傳遞該路徑。 如果失敗，它會傳遞 lpszHelp 所指向的路徑。

如果從任何內容呼叫，但目前使用者，此函式會失敗。

關閉要求協助的視窗之前，應用程式必須呼叫 MLWinHelp ，並將 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 主題。 如果使用者按兩下 [內容 ] 按鈕，如果說明檔沒有相關聯的 .cnt 檔案，Windows 說明會顯示本主題。	包含 Contents 主題的內容識別碼。
HELP_SETPOPUP_POS	設定後續彈出視窗的位置。	包含位置數據。 使用MAKELONG宏，將水準和垂直座標串連成單一值。 彈出視窗的位置就像在叫用彈出視窗時，滑鼠游標位於指定的點。
HELP_SETWINPOS	如果視窗最小化或記憶體中，則會顯示 [Windows 說明] 視窗，並依照指定設定其大小和位置。	HELPWININFO 結構的位址，指定主要或次要說明視窗的大小和位置。
HELP_TCARD	指出命令適用於 Windows 說明的定型卡片實例。 使用位 OR 運算符，將此命令與其他命令結合。	取決於結合此命令的命令。
HELP_WM_HELP	在彈出視窗中顯示 hWndMain 參數所識別之控件的主題。	DWORD 配對陣列的位址。 每對中的第一 個 DWORD 是控件識別碼，第二個是主題的內容標識碼。 陣列必須以一對零 {0,0}終止。 如果您不想將說明新增至特定控件，請將其內容識別符設定為 -1。

 

需求

需求	值
最低支援的用戶端	Windows 2000 Professional、Windows XP [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2003 [僅限傳統型應用程式]
頁首	無
DLL	Shlwapi.dll （5.0 版或更新版本）
Unicode 和 ANSI 名稱	MLWinHelpW （Unicode） 和 MLWinHelpA （ANSI）

另請參閱

HELPWININFO

MULTIKEYHELP