RoOriginateError function

Reports an error and an informative string to an attached debugger.

Syntax

BOOL RoOriginateError(
  HRESULT error,
  HSTRING message
);

Parameters

error

Type: HRESULT

The error code associated with the error condition. If error is a success code, such as S_OK, the function has no effect and returns FALSE. This behavior enables calling the function when no error has occurred without causing an unwanted error message.

message

Type: HSTRING

An informative string to help developers to correct the reported error condition. The maximum length is 512 characters, including the trailing NUL character; longer strings are truncated.

If the string is empty, the function succeeds but no error information is reported. It is recommended that you always provide an informative string.

If message is NULL, the function succeeds and reports the generic string in Winerror.h if available or the generic string associated with E_FAIL.

This function does not support embedded NUL characters, so only the characters before the first NUL are reported.

The message string should be localized.

Return Value

Type: BOOL

Return code Description
TRUE
The error message was reported successfully.
FALSE
message is NULL or points to an empty string, or error is a success code.

Remarks

Use the RoOriginateError function to report an error condition and a corresponding message to a debugger. This function does not perform logging or event tracing.

The error is communicated to the debugger by raising a structured exception. This exception is caught by the attached debugger, and the exception parameters contain both the error and the message string. The debugger may display these parameters to the user.

Depending on the current configuration of the debugger, the RoOriginateError function may cause execution to halt in the debugger at the site of the exception.

If the UseSetErrorInfo flag is set by calling the RoSetErrorReportingFlags function, and the calling thread has been initialized in COM, the function creates an appropriate error object that supports IRestrictedErrorInfo and associates it with the COM channel by calling SetErrorInfo. If the thread has not been initialized into COM, the call will still succeed with no error, but the error will not be associated with the COM channel.

Requirements

   
Minimum supported client Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Target Platform Windows
Header roerrorapi.h
Library RuntimeObject.lib

See Also

RO_ERROR_REPORTING_FLAGS

RoGetErrorReportingFlags

RoOriginateErrorW

RoSetErrorReportingFlags

RoTransformError