{"id":39443,"date":"2004-05-07T07:01:00","date_gmt":"2004-05-07T07:01:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/oldnewthing\/2004\/05\/07\/when-should-your-destructor-be-virtual\/"},"modified":"2004-05-07T07:01:00","modified_gmt":"2004-05-07T07:01:00","slug":"when-should-your-destructor-be-virtual","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/oldnewthing\/20040507-00\/?p=39443","title":{"rendered":"When should your destructor be virtual?"},"content":{"rendered":"

When should your C++ object’s destructor be virtual? <\/p>\n

First of all, what does it mean to have a virtual destructor? <\/p>\n

Well, what does it mean to have a virtual method? <\/p>\n

If a method is virtual, then calling the method on an object always invokes the method as implemented by the most heavily derived class. If the method is not virtual, then the implementation corresponding to the compile-time type of the object pointer. <\/p>\n

For example, consider this: <\/p>\n

class Sample {\npublic:\n void f();\n virtual void vf();\n};\nclass Derived : public Sample {\npublic:\n void f();\n void vf();\n}\nvoid function()\n{\n Derived d;\n Sample* p = &d;\n p->f();\n p->vf();\n}\n<\/pre>\n
The call to p->f()<\/code> will result in a call to Sample::f<\/code> because p<\/code> is a pointer to a Sample<\/code>. The actual object is of type Derived<\/code>, but the pointer is merely a pointer to a Sample<\/code>. The pointer type is used because f<\/code> is not virtual. <\/p>\n
On the other hand, the call to The call to p->vf()<\/code> will result in a call to Derived::vf<\/code>, the most heavily derived type, because vf<\/code> is virtual. <\/p>\n
Okay, you knew that. <\/p>\n
Virtual destructors work exactly the same way. It’s just that you rarely invoke the destructor explicitly. Rather, it’s invoked when an automatic object goes out of scope or when you delete<\/code> the object. <\/p>\n
void function()\n{\n Sample* p = new Derived;\n delete p;\n}\n<\/pre>\n
Since Sample<\/code> does not have a virtual destructor, the delete p<\/code> invokes the destructor of the class of the pointer (Sample::~Sample()<\/code>), rather than the destructor of the most derived type (Derived::~Derived()<\/code>). And as you can see, this is the wrong thing to do in the above scenario. <\/p>\n
Armed with this information, you can now answer the question. <\/p>\n
A class must have a virtual destructor if it meets both of the following criteria: <\/p>\n
    \n
  • You do a delete p<\/code>.\n
  • It is possible that p<\/code> actually points to a derived class. <\/li>\n<\/ul>\n
    Some people say that you need a virtual destructor if and only if you have a virtual method. This is wrong in both directions. <\/p>\n
    Example of a case where a class has no virtual methods but still needs a virtual destructor: <\/p>\n
    class Sample { };\nclass Derived : public Sample\n{\n CComPtr<IStream> m_p;\npublic:\n Derived() { CreateStreamOnHGlobal(NULL, TRUE, &m_p); }\n};\nSample *p = new Derived;\ndelete p;\n<\/pre>\n
    The delete p<\/code> will invoke Sample::~Sample<\/code> instead of Derived::~Derived<\/code>, resulting in a leak of the stream m_p<\/code>. <\/p>\n
    And here’s an example of a case where a class has virtual methods but does not require a virtual destructor. <\/p>\n
    class Sample { public: virtual void vf(); }\nclass Derived : public Sample { public: virtual void vf(); }\nDerived *p = new Derived;\ndelete p;\n<\/pre>\n
    Since the object deletion occurs from the pointer type that matches the type of the actual object, the correct destructor will be invoked. This pattern happens often in COM objects, which expose several virtual methods corresponding to its interfaces, but where the object itself is destroyed by its own implementation and not from a base calss pointer. (Notice that no COM interfaces contain virtual destructors.) <\/p>\n
    The problem with knowing when to make your destructor virtual or not is that you have to know how people will be using your class. If C++ had a “sealed” keyword, then the rule would be simpler: If you do a “delete p<\/code>” where p<\/code> is a pointer to an unsealed class, then that class needs have a virtual destructor. (The imaginary “sealed” keyword makes it explicit when a class can act as the base class for another class.) <\/p>\n","protected":false},"excerpt":{"rendered":"
    When should your C++ object’s destructor be virtual? First of all, what does it mean to have a virtual destructor? Well, what does it mean to have a virtual method? If a method is virtual, then calling the method on an object always invokes the method as implemented by the most heavily derived class. If […]<\/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-39443","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-oldnewthing","tag-code"],"acf":[],"blog_post_summary":"
    When should your C++ object’s destructor be virtual? First of all, what does it mean to have a virtual destructor? Well, what does it mean to have a virtual method? If a method is virtual, then calling the method on an object always invokes the method as implemented by the most heavily derived class. If […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/39443","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=39443"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/posts\/39443\/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=39443"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/categories?post=39443"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/oldnewthing\/wp-json\/wp\/v2\/tags?post=39443"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}