RoOriginateError 関数 (roerrorapi.h)

[アーティクル]
03/01/2024

アタッチされたデバッガーにエラーと情報文字列を報告します。

構文

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

パラメーター

[in] error

種類: HRESULT

エラー条件に関連付けられているエラーコード。 error が成功コード (S_OK など) の場合、関数は無効であり、FALSE を返します。この動作により、不要なエラーメッセージを引き起こさずにエラーが発生しなかった場合に関数を呼び出します。

[in] message

型: HSTRING

報告されたエラー状態を開発者が修正するのに役立つ情報文字列。最大長は、末尾の NUL 文字を含む 512 文字です。長い文字列は切り捨てられます。

文字列が空の場合、関数は成功しますが、エラー情報は報告されません。常に有益な文字列を指定することをお勧めします。

message が NULL の場合、関数は成功し、使用可能な場合は Winerror.h のジェネリック文字列、またはE_FAILに関連付けられている汎用文字列を報告します。

この関数は埋め込み NUL 文字をサポートしていないため、最初の NUL の前の文字のみが報告されます。

メッセージ文字列はローカライズする必要があります。

戻り値

種類: BOOL

リターンコード	説明
TRUE	エラーメッセージが正常に報告されました。
FALSE	message が NULL であるか、空の文字列を指しているか、エラーが成功コードです。

注釈

RoOriginateError 関数を使用して、エラー状態と対応するメッセージをデバッガーに報告します。この関数は、ログ記録やイベントトレースを実行しません。

エラーは、構造化例外を発生させることによってデバッガーに通知されます。この例外はアタッチされたデバッガーによってキャッチされ、例外パラメーターにはエラーと メッセージ 文字列の両方が含まれます。デバッガーでは、これらのパラメーターをユーザーに表示できます。

デバッガーの現在の構成によっては、 RoOriginateError 関数によって、例外のサイトでデバッガーで実行が停止する場合があります。

RoSetErrorReportingFlags 関数を呼び出して UseSetErrorInfo フラグを設定し、呼び出し元のスレッドが COM で初期化されている場合、関数は IRestrictedErrorInfo をサポートする適切なエラーオブジェクトを作成し、SetErrorInfo を呼び出して COM チャネルに関連付けます。スレッドが COM に初期化されていない場合でも、呼び出しはエラーなしで成功しますが、エラーは COM チャネルに関連付けられません。

要件

要件	値
サポートされている最小のクライアント	Windows 8 [デスクトップアプリ \|UWP アプリ]
サポートされている最小のサーバー	Windows Server 2012 [デスクトップアプリ \|UWP アプリ]
対象プラットフォーム	Windows
ヘッダー	roerrorapi.h
Library	RuntimeObject.lib