Feature: Add support for message in WIL logging handler

[arthuraraujo-msft]

Version

2.0.240405.15

Summary

It'd be great to have support for messages along with exceptions when using the winrt_throw_hresult_handler handler that was created for WIL logging hooks.
The implementation at hresult_error::originate() seems like a good place to do it since it already has access to a message. It could pass that to the handler.
WIL would also require a change to support passing that message to its callbacks.

Reproducible example

Expected behavior

No response

Actual behavior

No response

Additional comments

No response

[dmachaj]

This seems like something that could be added, although I don't think the existing winrt_throw_hresult_handler could have its signature changed. That would break compatibility with WIL, and the versions of WIL/cppwinrt can change independently from each other, so that kind of break would be very bad.

A new handler signature that includes a message argument could be added. Then both sides would need the appropriate cross-compatibility checks to decide whether to use the new or old signature. When both are recent enough it would include the message argument in the WIL logging.

This seems like a decently large pain to coordinate. The message is logged to RoOriginateError so it is available in the debugger but not in the WIL logging. The question is whether adding it to the WIL logging is worth the investment.

[arthuraraujo-msft]

A suggestion was given over on the wil repo https://www.github.com/microsoft/wil/issues/495 to make use of the result_originate.h header, which makes use of the logging to RoOriginateError to add the message to the WIL result logging callbacks as was my end goal with the original request.
Closing this is as not needed.