{"id":109214,"date":"2024-01-01T07:00:00","date_gmt":"2024-01-01T15:00:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/oldnewthing\/?p=109214"},"modified":"2023-12-31T21:42:54","modified_gmt":"2024-01-01T05:42:54","slug":"20240101-00","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20240101-00\/?p=109214","title":{"rendered":"How do I prevent my ATL class from participating in COM aggregation? DECLARE_NOT_AGGREGATABLE<\/CODE> didn’t work"},"content":{"rendered":"

Consider the following ATL class declaration:<\/p>\n

class Widget :\r\n    public CComObjectRootEx<CComMultiThreadModel>,\r\n    public CComCoClass<Widget>,\r\n    public IAgileObject\r\n{\r\npublic :\r\n    DECLARE_NOT_AGGREGATABLE(Widget)<\/span>\r\n\r\n    BEGIN_COM_MAP(Widget)\r\n        COM_INTERFACE_ENTRY(IAgileObject)\r\n    END_COM_MAP()\r\n\r\n    \u27e6 ... \u27e7\r\n};\r\n<\/pre>\n
This class says that it is not aggregatable.<\/p>\n
Hold my beer.<\/p>\n
HRESULT CreateAggregatedWidget(\r\n    IUnknown* punkOuter, REFIID riid, void** ppv)\r\n{\r\n    return\r\n        CComCreator<CComAggObject<Widget>>::\r\n            CreateInstance(punkOuter, riid, pppv);\r\n}\r\n<\/pre>\n
There, I aggregated your allegedly non-aggregatable object.<\/p>\n
The DECLARE_NOT_AGGREGATABLE<\/code> macro is an instruction to the class factory to disallow aggregation, but if you create the object by means other than the class factory, then the macro has no effect. Creating the object without using the class factory is common for objects created internally.<\/p>\n
So how do you mark your class so that any attempt to aggregate the object encounters a compiler error?<\/p>\n
I found a sneaky trick.<\/p>\n
The CComAggObject<\/code> template sets up aggregation by creating the inner object and overriding its IUnknown<\/code> methods to forward to the controlling unknown,  kept in the member variable m_pOuterUnknown<\/code><\/a>. The connection is made here:<\/p>\n
template <class Base>\r\nclass CComContainedObject :\r\n    public Base\r\n{\r\npublic:\r\n    typedef Base _BaseBlass;\r\n\r\n    CComContainedObject(void* pv)\r\n    {\r\n        this->m_pOuterUnknown = (IUnknown*)pv;<\/span>\r\n    }\r\n<\/pre>\n
If we can make this line of code produce an error, then we can prevent people from instantiating CComContainedObject<Widget><\/code> and thereby prevent them from putting it in a CComAggObject<\/code>.<\/p>\n
I had multiple ideas for how to accomplish this, but the simplest was this:<\/p>\n
class Widget :\r\n    public CComObjectRootEx<CComMultiThreadModel>,\r\n    public CComCoClass<Widget>,\r\n    public IAgileObject\r\n{\r\npublic :\r\n    DECLARE_NOT_AGGREGATABLE(Widget)\r\n\r\n    static constexpr void* m_pOuterUnknown = nullptr;<\/span>\r\n\r\n    BEGIN_COM_MAP(Widget)\r\n        COM_INTERFACE_ENTRY(IAgileObject)\r\n    END_COM_MAP()\r\n\r\n    \u27e6 ... \u27e7\r\n};\r\n<\/pre>\n
This shadows the m_pOuterUnknown<\/code> member from CComObjectRootEx<\/code>, so when CComContainedObject<\/code> tries to do a this->m_pOuterUnknown<\/code>, it gets the Widget<\/code> one. And since the Widget<\/code> one is marked constexpr<\/code>, it cannot be modified.<\/p>\n
error C3892: 'm_pOuterUnknown': you cannot assign to a variable that is const\r\n<\/pre>\n
If you are compiling with a version of C++ that doesn’t support constexpr<\/code> (which is not entirely out of the question given that you’re using ATL, and ATL was written in 1996, over a decade before constexpr<\/code> was  a twinkle in Gabriel and Bjarne’s eyes<\/a>), you can use this alternate shadowing definition:<\/p>\n
    static void m_pOuterUnknown() {}\r\n<\/pre>\n
This makes m_pOuterUnknown<\/code> a function, and you cannot assign to a function.<\/p>\n
error C2659: '=': function as left operand\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
That marker applies only to creation via the class factory.<\/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-109214","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
That marker applies only to creation via the class factory.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/109214","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=109214"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/109214\/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=109214"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=109214"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=109214"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}