{"id":105617,"date":"2021-08-30T07:00:00","date_gmt":"2021-08-30T14:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=105617"},"modified":"2023-09-14T09:56:38","modified_gmt":"2023-09-14T16:56:38","slug":"20210830-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20210830-00\/?p=105617","title":{"rendered":"The various ways of moving between C++\/WinRT and classic COM"},"content":{"rendered":"

Windows Runtime language projections create parallel universes with types that correspond to the ABI types, but which are expressed in a projection-specific way. For the C++ projections (C++\/WinRT and C++\/CX), these projected types go even further: Not only do they correspond to the ABI types, but their internal layouts are identical to the ABI types. This means that you can use reinrepret-casting to convert between them.<\/p>\n

Suppose we have a Windows Runtime Contoso.Widget<\/code> with its associated default interface Contoso.IWidget<\/code>.<\/p>\n

C++\/WinRT and C++\/CX set up parallel universes like this:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
C++\/WinRT<\/th>\nABI<\/th>\nC++\/CX<\/th>\n<\/tr>\n
\u00a0<\/td>\n<\/tr>\n<\/tbody>\n
winrt::Contoso::Widget<\/tt><\/td>\nABI::Contoso::Widget*<\/tt><\/td>\nContoso::Widget^<\/tt><\/td>\n<\/tr>\n
winrt::Contoso::IWidget<\/tt><\/td>\nABI::Contoso::IWidget*<\/tt><\/td>\nContoso::IWidget^<\/tt><\/td>\n<\/tr>\n<\/tbody>\n
\u00a0<\/td>\n<\/tr>\n
winrt::Windows::Foundation::IInspectable<\/tt><\/td>\n::IInspectable*<\/tt><\/td>\nPlatform::Object^<\/tt><\/td>\n<\/tr>\n
\u00a0<\/td>\n<\/tr>\n
winrt::Windows::Foundation::IUnknown<\/tt><\/td>\n::IUnknown*<\/tt><\/td>\n\u00a0<\/td>\n<\/tr>\n
\u00a0<\/td>\n<\/tr>\n
winrt::hstring<\/tt><\/td>\n::HSTRING<\/tt><\/td>\nPlatform::String^<\/tt><\/td>\n<\/tr>\n
\u00a0<\/td>\n<\/tr>\n
winrt::Contoso::SomeStruct<\/tt><\/td>\nABI::Contoso::SomeStruct<\/tt><\/td>\nContoso::SomeStruct<\/tt><\/td>\n<\/tr>\n
\u00a0<\/td>\n<\/tr>\n
winrt::Contoso::SomeEnum<\/tt><\/td>\nABI::Contoso::SomeEnum<\/tt><\/td>\nContoso::SomeEnum<\/tt><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

All of the entities in a block have the same internal representation and are therefore interchangeable at the ABI. They are just wrapped in different types.<\/p>\n

It’s not too difficult to move up and down the columns, since you are staying inside the same family of types. But moving between columns is usually much uglier, since you’re travelling between universes.<\/p>\n

A case where you may find yourself needing to move between columns is when you want to use a classic COM interface exposed by a Windows Runtime object. Classic COM interfaces exist only in the ABI world; there is no corresponding version in C++\/WinRT or C++\/CX.<\/p>\n

One way to move between the C++\/WinRT and ABI columns is to use C++\/WinRT ABI-interop functions.<\/p>\n

For getting ABI pointers out of C++\/WinRT reference types and strings:<\/p>\n\n\n\n\n\n\n
Expression<\/th>\nx<\/code><\/th>\nv<\/code> receives<\/th>\nNotes<\/th>\n<\/tr>\n
v = get_abi(x)<\/code><\/td>\nUnchanged<\/td>\nNon-refcounted pointer<\/td>\nLifetime controlled by x<\/code><\/td>\n<\/tr>\n
copy_to_abi(x, v)<\/code><\/td>\nUnchanged<\/td>\nRefcounted pointer<\/td>\nNew refcount added<\/td>\n<\/tr>\n
v = detach_abi(x)<\/code><\/td>\nEmptied<\/td>\nRefcounted pointer<\/td>\nOwnership transfer<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

And for putting ABI pointers into C++\/WinRT reference types and strings:<\/p>\n\n\n\n\n\n\n
Expression<\/th>\nx<\/code>‘s old value<\/th>\nv<\/code><\/th>\nNotes<\/th>\n<\/tr>\n
*put_abi(x) = v<\/code><\/td>\nReleased<\/td>\nNo longer owning<\/td>\nOwnership transfer<\/td>\n<\/tr>\n
copy_from_abi(x, v)<\/code><\/td>\nReleased<\/td>\nStill owning<\/td>\nReference-counted copy<\/td>\n<\/tr>\n
attach_abi(x, v)<\/code><\/td>\nReleased<\/td>\nNo longer owning<\/td>\nOwnership transfer<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

A customer had a C++\/WinRT Contoso.Widget<\/code> and wanted to get the raw ABI ::IUnknown*<\/code> from it, so that they could pass it to Co\u00adSet\u00adProxy\u00adBlanket<\/code>. Here’s one way to do it:<\/p>\n

winrt::check_hresult(\r\n    CoSetProxyBlanket(\r\n        reinterpret_cast<::IUnknown*>(winrt::get_abi(thing))<\/span>,\r\n        RPC_C_AUTHN_DEFAULT,\r\n        RPC_C_AUTHZ_DEFAULT,\r\n        COLE_DEFAULT_PRINCIPAL,\r\n        RPC_C_AUTHN_LEVEL_DEFAULT,\r\n        RPC_C_IMP_LEVEL_IMPERSONATE,\r\n        nullptr \/*pAuthInfo*\/,\r\n        EOAC_NONE));\r\n<\/pre>\n
Another way to do it is to use winrt::com_ptr<\/code>, which gives you a little bridge to the classic COM world, provided you include <unknwn.h><\/code> before including any C++\/WinRT header files.<\/p>\n
winrt::check_hresult(\r\n    CoSetProxyBlanket(\r\n        thing.as<::IUnknown>().get()<\/span>,\r\n        RPC_C_AUTHN_DEFAULT,\r\n        RPC_C_AUTHZ_DEFAULT,\r\n        COLE_DEFAULT_PRINCIPAL,\r\n        RPC_C_AUTHN_LEVEL_DEFAULT,\r\n        RPC_C_IMP_LEVEL_IMPERSONATE,\r\n        nullptr \/*pAuthInfo*\/,\r\n        EOAC_NONE));\r\n<\/pre>\n
If you’re the sort of person who worries about such things, do note that as()<\/code> performs a Query\u00adInterface<\/code> call, whereas get_abi<\/code> is basically free because it just reaches in and gives you the embedded pointer.<\/p>\n
Structures and enumerations are simpler to manage, since there is no reference count. You can just reinterpret_cast<\/code> between the types:<\/p>\n
winrt::Contoso::SomeStruct s1;\r\nABI::Contoso::SomeStruct s2 = reinterpret_cast<ABI::Contoso::SomeStruct&>(s1);\r\n\r\nwinrt::Contoso::SomeEnum e1;\r\nABI::Contoso::SomeEnum e2 = reinterpret_cast<ABI::Contoso::SomeEnum>(e1);\r\n<\/pre>\n
Bonus chatter<\/b>: Really, you can just reinterpret_cast<T&><\/code> to move between columns, even for reference types, since the internal representations are the same.<\/p>\n
winrt::Anything a1;\r\nABI::Anything a2;\r\n::Anything a3;\r\n\r\na1 = reinterpret_cast<winrt::Anything&>(a2);\r\na1 = reinterpret_cast<winrt::Anything&>(a3);\r\n\r\na2 = reinterpret_cast<ABI::Anything&>(a1);\r\na2 = reinterpret_cast<ABI::Anything&>(a3);\r\n\r\na3 = reinterpret_cast<::Anything&>(a1);\r\na3 = reinterpret_cast<::Anything&>(a2);\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
Crossing to the other side.<\/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-105617","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
Crossing to the other side.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/105617","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=105617"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/105617\/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=105617"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=105617"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=105617"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}