{"id":110338,"date":"2024-10-04T07:00:00","date_gmt":"2024-10-04T14:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=110338"},"modified":"2024-10-04T12:35:08","modified_gmt":"2024-10-04T19:35:08","slug":"20241004-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20241004-00\/?p=110338","title":{"rendered":"How does the linker decide whether to call WinMain<\/CODE> or wWinMain<\/CODE>?"},"content":{"rendered":"

If you don’t specify the \/ENTRY<\/tt> option to the Visual C++ linker, it tries to guess. The details are spelled out in the documentation<\/a>, but I’ll recapture it here since it will lead to a troubleshooting session.<\/p>\n

First, if you specified the \/DLL<\/tt> flag, then the default entry point is _DllMainCRTStartup<\/tt>. That’s the easy case.<\/p>\n

If you did not specify the \/DLL<\/tt> flag, then the linker looks at your \/SUBSYSTEM<\/tt> flag. If you asked for \/SUBSYSTEM:CONSOLE<\/tt>, then it looks for wmain<\/code> and main<\/code>. If you asked for \/SUBSYSTEM:WINDOWS<\/tt>, then it looks for wWinMain<\/code> and WinMain<\/code>. If you didn’t specify a subsystem, then it looks for all four symbols, and whichever symbol it finds first determines what the implied \/ENTRY<\/tt> is:<\/p>\n\n\n\n\n\n\n\n
If linker finds<\/td>\nThen entry point is<\/td>\n<\/tr>\n
wmain<\/tt><\/td>\nwmainCRTStartup<\/tt><\/td>\n<\/tr>\n
main<\/tt><\/td>\nmainCRTStartup<\/tt><\/td>\n<\/tr>\n
wWinMain<\/tt><\/td>\nwWinMainCRTStartup<\/tt><\/td>\n<\/tr>\n
WinMain<\/tt><\/td>\nWinMainCRTStartup<\/tt><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

The search for these magic symbols is made over the symbols present in the module after external references have been resolved (according to the classical model for linking<\/a>).\u00b9 If there is no match for anything, then it uses the ANSI entry point and hopes for the best.<\/p>\n

Okay, now you can try to solve this customer’s problem:<\/p>\n

We have several programs that follow the same overall structure. The idea is that we will put the wWinMain<\/code> function in a common static library, and the wWinMain<\/code> function will use global variables (defined differently in each program) to manage the program-specific business logic. But when we do that, we get a linker error saying “unresolved external symbol WinMain referenced by invoke_main.” It works if we use WinMain<\/code>, but we want to support Unicode.<\/p><\/blockquote>\n

Moving the wWinMain<\/code> function into a library means that the linker doesn’t see it when looking through your module’s symbols trying to find an entry point. It therefore assumes ANSI and then gets stuck when it can’t find WinMain<\/code>.<\/p>\n

One way to solve this is to require clients of the library to define their own wWinMain<\/code>, but have it just forward the call to your library.<\/p>\n

int WINAPI wWinMain(HINSTANCE hinst,\r\n    HINSTANCE hinstPrev,\r\n    PWSTR pszCmdLine,\r\n    int nCmdShow)\r\n{\r\n    return Contoso::wWinMain(hinst, hinstPrev,\r\n            pszcmdLine, nCmdShow);\r\n}\r\n<\/pre>\n
Now that the wWinMain<\/code> function is defined in the project object files, the linker will see it and use it as the entry point.<\/p>\n
Having a separate function into which clients forward their wWinMain<\/code> also means that it’s possible for a program to use multiple libraries.<\/p>\n
int WINAPI wWinMain(HINSTANCE hinst,\r\n    HINSTANCE hinstPrev,\r\n    PWSTR pszCmdLine,\r\n    int nCmdShow)\r\n{\r\n    if (GetConfiguration(\"useContoso\")) {\r\n        return Contoso::wWinMain(hinst, hinstPrev,\r\n                pszcmdLine, nCmdShow);\r\n    } else {\r\n        return Fabrikam::wWinMain(hinst, hinstPrev,\r\n                pszcmdLine, nCmdShow);\r\n    }\r\n}\r\n<\/pre>\n
If you don’t really care about peaceful coexistence with other libraries, another solution would be to have a function that everybody must call, but which doesn’t do anything,\u00b2 and put that function in the same .obj file as your wWinMain<\/code>. The classical model of linking will try to resolve that function, and it will pull in the .obj file from the library, and that .obj file carries wWinMain<\/code> along for the ride.<\/p>\n
Another possibility is to just put WinMain<\/code> in your library, since that’s the name that the linker will use for a \/SUBSYSTEM:WINDOWS<\/code> module if it can’t find wWinMain<\/code>. Your WinMain<\/code> can ignore its ANSI command line and call Get\u00adCommand\u00adLineW()<\/code> to get the Unicode command line.<\/p>\n
But probably the easiest solution if you don’t care about peaceful coexistence with other libraries is to add a<\/p>\n
#pragma comment(linker, \"\/include:wWinMain\")\r\n<\/pre>\n
This forces the linker to resolve wWinMain<\/code>, and it will find it in your library and add its object file to your project, at which point the “Gosh, what entry point should I use?” will see that wWinMain<\/code> is present and use it.<\/p>\n
\u00b9 Naturally, this is done prior to dead code removal: Without an entry point, all you have is dead code!<\/p>\n
\u00b2 Basically, you’re using the  InitCommonControls trick<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
If you don’t tell it, it will try to figure it out.<\/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-110338","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
If you don’t tell it, it will try to figure it out.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/110338","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=110338"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/110338\/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=110338"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=110338"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=110338"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}