SHMessageBoxCheckW 函式 (shlwapi.h)
[SHMessageBoxCheck 可用於需求一節中指定的操作系統。 後續版本可能會變更或無法使用。]
顯示消息框,為使用者提供隱藏進一步出現的選項。 如果使用者已選擇隱藏消息框,函式就不會顯示對話框,而是只傳回預設值。
語法
int SHMessageBoxCheckW(
[in, optional] HWND hwnd,
[in] LPCWSTR pszText,
[in] LPCWSTR pszCaption,
UINT uType,
int iDefault,
[in] LPCWSTR pszRegVal
);
參數
[in, optional] hwnd
類型: HWND
消息框擁有者的視窗句柄。 此值可以是 NULL。
[in] pszText
類型: LPCTSTR
包含要顯示之訊息之 Null 終止字串的指標。
[in] pszCaption
類型: LPCTSTR
包含消息框標題之 Null 終止字串的指標。 如果此參數設定為 NULL,標題會設定為 Error!。
uType
類型: UINT
指定消息框內容和行為的旗標。 此函式僅支援 MessageBox 所支援的旗標子集。 如果您使用以下未列出的任何旗標,則未定義函式的行為。
您必須藉由設定一個和下列其中一個旗標來指定要顯示的按鈕。
MB_OKCANCEL
顯示消息框,其中包含 [確定 ] 和 [ 取消] 按鈕。
MB_YESNO
顯示含有 [是 ] 和 [ 否 ] 按鈕的消息框。
MB_OK
顯示具有 [ 確定 ] 按鈕的消息框。
您可以藉由設定一個和下列其中一個旗標來顯示選擇性圖示。
MB_ICONHAND
顯示停用符號圖示。
MB_ICONQUESTION
顯示問號圖示。
MB_ICONEXCLAMATION
顯示驚嘆號圖示。
MB_ICONINFORMATION
在圓形中顯示具有小寫 「i」 的圖示。
iDefault
類型: int
當使用者選擇不要再次顯示消息框時,函式會傳回的值。 如果使用者尚未選擇隱藏消息框,則會顯示消息框,且函式會忽略 iDefault。
[in] pszRegVal
類型: LPCTSTR
Null 終止字串的指標,其中包含與這個訊息相關聯的唯一字串值。 為了避免與 Microsoft 使用的值發生衝突,此字串應該包含 GUID。 此字串長度不能超過REGSTR_MAX_VALUE_LENGTH個字元,包括終止的 Null 字元。
傳回值
類型: int
如果使用者已選擇隱藏消息框,函式會立即傳回指派給 iDefault的值。
如果使用者按兩下 [ 確定]、[ 取消]、[ 是] 或 [ 否 ] 按鈕,則函式會分別傳回IDOK、IDCANCEL、IDYES 或IDNO。
如果使用者按兩下 標題中的 X 按鈕來關閉訊息框,函式會傳回 IDCANCEL。 即使尚未設定MB_OKCANCEL旗標,這個值仍會傳回。
如果發生錯誤,則傳回值通常是 –1。 不過,在某些記憶體不足的情況下,函式可能會傳回 iDefault。
備註
安全性警告: 如果函式傳回 –1 或 iDefault,請勿採取任何危險動作。 如果嘗試顯示消息框時發生錯誤, SHMessageBoxCheck 會傳回 –1,在某些情況下為 iDefault。 這類錯誤可能是記憶體或資源不足所造成。 如果您收到其中一個傳回值,您應該注意使用者不一定會看到對話框,因此不一定同意任何動作。
請勿混淆「不要顯示此對話框」與「記住此答案」。 SHMessageBoxCheck 不提供「記住此答案」功能。 如果使用者再次選擇隱藏消息框,函式不會保留他們按下的按鈕。 相反地, SHMessageBoxCheck 的後續調用只會傳回 iDefault 所指定的值。 請思考一下下列範例。
int iResult = SHMessageBoxCheck(hwnd,
TEXT("Do you want to exit without saving?"),
TEXT("Warning"),
MB_YESNO,
IDNO,
TEXT("{d9108ba3-9a61-4398-bfbc-b02102c77e8a}");
如果使用者選取 [ 未來],請勿顯示此對話框, 然後按兩下 [ 是 ] 按鈕, SHMessageBoxCheck 會傳回IDYES。 不過,下次執行此程式代碼時, SHMessageBoxCheck 不會傳回 IDYES,即使使用者原本選取了 [是 ]。 相反地,它會傳回IDNO,因為這是 iDefault所指定的值。
消息框所顯示的預設按鈕應該同意您的 iDefault 值。 缺少MB_DEFBUTTON2旗標的支援表示如果您已指定 MB_OK 或 MB_OKCANCEL 旗標, iDefault 應該設定為IDOK。 如果您已設定 MB_YESNO 旗標, iDefault 值應該設定為 IDYES。
SHMessageBoxCheck 會 記錄用戶選擇在下列登錄機碼下隱藏的消息框。
HKEY_CURRENT_USER Software Microsoft Windows CurrentVersion Explorer LowRegistry DontShowMeThisDialogAgain
注意
shlwapi.h 標頭會將SHMessageBoxCheck定義為別名,根據UNICODE預處理器常數的定義,自動選取此函式的ANSI或Unicode版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱 函式原型的慣例。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | shlwapi.h |
Dll | Shlwapi.dll (5.0 版或更新版本) |