RoOriginateError 函式 (roerrorapi.h)

發行項
03/01/2024

向附加調試程序報告錯誤和資訊字串。

語法

BOOL RoOriginateError(
  [in] HRESULT error,
  [in] HSTRING message
);

參數

[in] error

類型： HRESULT

與錯誤條件相關聯的錯誤碼。如果 error 是成功碼，例如 S_OK，則函式沒有任何作用並傳回 FALSE。此行為可在未發生任何錯誤時呼叫函式，而不會造成不必要的錯誤訊息。

[in] message

類型： HSTRING

資訊字串，可協助開發人員更正回報的錯誤狀況。最大長度為 512 個字元，包括尾端 NUL 字元;會截斷較長的字串。

如果字串是空的，函式會成功，但不會報告任何錯誤資訊。建議您一律提供資訊字串。

如果 message 為 NULL，則函式會成功並報告 Winerror.h 中的泛型字串，如果有的話，或與 E_FAIL 相關聯的泛型字串。

此函式不支援內嵌 NUL 字元，因此只會報告第一個 NUL 之前的字元。

訊息字串應該當地語系化。

傳回值

類型： BOOL

傳回碼	Description
TRUE	已成功報告錯誤訊息。
FALSE	訊息為 NULL 或指向空字串，或錯誤為成功碼。

備註

使用 RoOriginateError 函 式向調試程式報告錯誤狀況和對應的訊息。此函式不會執行記錄或事件追蹤。

藉由引發結構化例外狀況，錯誤會傳達給調試程式。附加調試程式會攔截此例外狀況，而且例外狀況參數同時包含錯誤和訊息字串。調試程式可能會向用戶顯示這些參數。

根據調試程式的目前組態， RoOriginateError 函 式可能會導致在例外狀況月臺的調試程式中停止執行。

如果 UseSetErrorInfo 旗標是藉由呼叫 RoSetErrorReportingFlags 函式來設定，而且呼叫線程已在 COM 中初始化，則函式會建立適當的錯誤物件，以支援 IRestrictedErrorInfo ，並藉由呼叫 SetErrorInfo 將它與 COM 通道產生關聯。如果線程尚未初始化為 COM，呼叫仍會成功且沒有任何錯誤，但錯誤不會與 COM 通道相關聯。

規格需求

需求	值
最低支援的用戶端	Windows 8 [傳統型應用程式 \|UWP 應用程式]
最低支援的伺服器	Windows Server 2012 [傳統型應用程式 \|UWP 應用程式]
目標平台	Windows
標頭	roerrorapi.h
程式庫	RuntimeObject.lib