{"id":110614,"date":"2024-12-06T07:00:00","date_gmt":"2024-12-06T15:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=110614"},"modified":"2024-12-09T22:30:02","modified_gmt":"2024-12-10T06:30:02","slug":"20241206-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20241206-00\/?p=110614","title":{"rendered":"Learning to read C++ compiler errors: Nonsensical errors from a function declaration"},"content":{"rendered":"

A customer wanted to add XAML support to their application, so they included (among other things) the header file winrt\/Windows.UI.Xaml.h<\/tt>. But the mere act of including that header file produced a horrible series of errors that began with.<\/p>\n

winrt\\impl\\Windows.UI.Xaml.0.h(4323,28): warning C4003: not enough arguments for function-like macro invocation 'ErrorMessage'\r\nwinrt\\impl\\Windows.UI.Xaml.0.h(4323,28): error C2146: syntax error: missing ')' before identifier 'ErrorMessageString'\r\nwinrt\\impl\\Windows.UI.Xaml.0.h(4323,28): error C3646: 'ErrorMessageString': unknown override specifier\r\nwinrt\\impl\\Windows.UI.Xaml.0.h(4323,28): error C2059: syntax error: ')'\r\nwinrt\\impl\\Windows.UI.Xaml.0.h(4323,48): error C2238: unexpected token(s) preceding ';'\r\n<\/pre>\n
What’s going on?<\/p>\n
The errors are coming from the following line of code:<\/p>\n
    template <typename D>\r\n    struct consume_Windows_UI_Xaml_IExceptionRoutedEventArgs\r\n    {\r\n        [[nodiscard]] auto ErrorMessage() const;<\/span>\r\n    };\r\n<\/pre>\n
That line of code looks like a perfectly fine method declaration. Why is the compiler upset?<\/p>\n
Look closely at the first error message.<\/p>\n
not enough arguments for function-like macro invocation 'ErrorMessage'\r\n<\/pre>\n
Wait a second, “function-like macro invocation”? This says that the compiler thinks you’re trying to use a macro called ErrorMessage<\/code>.\u00b9<\/p>\n
We suspected that the developer had a macro named ErrorMessage<\/code> elsewhere in their project, and that was conflicting with the method name. And with some help from the customer, we found it.<\/p>\n
\/\/ Produces the error text for an HRESULT.\r\nstruct ErrorMessageString\r\n{\r\n    ErrorMessageString(HRESULT hr);\r\n    operator PCWSTR() { return (PCWSTR)m_errorMessage; }\r\n    CStringW m_errorMessage;\r\n};\r\n\r\n#define ErrorMessage(hr) ((PCWSTR)ErrorMessageString(hr))\r\n<\/pre>\n
Bonus reading<\/b>:  Compiler error message metaprogramming: Helping to find the conflicting macro definition<\/a><\/p>\n
The ErrorMessage<\/code> macro creates an Error\u00adMessage\u00adString<\/code> object whose constructor looks up the error message string associated with the provided HRESULT<\/code>, and then forces it to produce a string pointer. Evidently, the intended purpose is to use it something like this:<\/p>\n
LogMessage(L\"Problem toggling the widget\", ErrorMessage(hr));\r\n<\/pre>\n
Macros have no respect for boundaries. The C++\/WinRT header file is trying to declare a method named Error\u00adMessage()<\/code>, and the macro steps in and says “I’ll take care of that!” It then sees that the code provides no parameters, but the macro requires one parameter, so you get the “not enough arguments” error. And then the compiler shrugs its shoulders and says, “Eh, I’ll just substitute it anyway,” and you end up with<\/p>\n
    template <typename D>\r\n    struct consume_Windows_UI_Xaml_IExceptionRoutedEventArgs\r\n    {\r\n        [[nodiscard]] auto ((PCWSTR)ErrorMessageString())<\/span> const;\r\n    };\r\n<\/pre>\n
This is nonsense, and the cascade errors are a bunch of error messages telling you how nonsensical this is.<\/p>\n
One solution is to remove the macro when including the troublesome header file.<\/p>\n
#pragma push_macro(\"ErrorMessage\")\r\n#undef ErrorMessage\r\n#pragma push_macro(\"GetCurrentTime\")\r\n#undef GetCurrentTime\r\n#pragma push_macro(\"TRY\")\r\n#undef TRY\r\n#include <winrt\/Windows.UI.Xaml.h>\r\n\u27e6 other C++\/WinRT headers ... \u27e7\r\n#pragma pop_macro(\"TRY\")\r\n#pragma pop_macro(\"GetCurrentTime\")\r\n#pragma pop_macro(\"ErrorMessage\")\r\n<\/pre>\n
I pre-emptively added Get\u00adCurrent\u00adTime<\/code> and TRY<\/code> because  you’re going to run into that problem really soon<\/a>, so we may as well take care of it now.<\/p>\n
Bonus reading<\/b>:  The Turkish lira’s currency code is an unexpected source of problems with computer programmers<\/a>.<\/p>\n
A better solution is simply to get rid of the macro.<\/span><\/p>\n
\/\/ Don't use this. It returns a dangling pointer.\r\ninline PCWSTR ErrorMessage(HRESULT hr) { return (PCWSTR)ErrorMessageString(hr); }<\/span>\r\n<\/pre>\n
\u00b9 A “function-like” macro is one that is defined with a parenthesized parameter list, possibly empty.<\/p>\n","protected":false},"excerpt":{"rendered":"
Look closely at what the error message is complaining about.<\/p>\n","protected":false},"author":1069,"featured_media":111744,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[25],"class_list":["post-110614","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
Look closely at what the error message is complaining about.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/110614","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/users\/1069"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/comments?post=110614"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/110614\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media\/111744"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/media?parent=110614"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=110614"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=110614"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}