RoTransformError function

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

Syntax

BOOL RoTransformError(
  HRESULT oldError,
  HRESULT newError,
  HSTRING message
);

Parameters

oldError

Type: HRESULT

The original error code associated with the error condition.

newError

Type: HRESULT

A different error code to associate with the error condition. If oldError and newError are the same, or both are success codes, such as S_OK, the function has no effect and returns FALSE.

message

Type: HSTRING

An informative string to help developers to correct the reported error condition. The maximum length is 512 characters, including the trailing null 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.

Although the message string is an HSTRING, the RoTransformError function does not support embedded null characters, so only the characters before the first null are reported.

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 oldError and newError are the same, or both are success codes.

Remarks

Use the RoTransformError function to substitute a custom error code for an existing error condition. For example, if the current error condition is E_FAIL, you can substitute a more specific error code, such as E_FILENOTFOUND, and report the transformed error to an attached debugger.

The behavior of the RoTransformError function is otherwise the same as the RoTransformErrorW function.

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

See Also

RO_ERROR_REPORTING_FLAGS

RoGetErrorReportingFlags

RoOriginateError

RoSetErrorReportingFlags

RoTransformErrorW