IDisposable.Dispose Méthode

Définition

Exécute les tâches définies par l'application associées à la libération ou à la redéfinition des ressources non managées.

public:
 void Dispose();
public void Dispose ();
abstract member Dispose : unit -> unit
Public Sub Dispose ()

Exemples

L’exemple suivant montre comment vous pouvez implémenter la Dispose méthode.

#using <System.dll>
#using <System.Windows.Forms.dll>

using namespace System;
using namespace System::ComponentModel;
using namespace System::Windows::Forms;

// The following example demonstrates how to create a class that 
// implements the IDisposable interface and the IDisposable.Dispose
// method with finalization to clean up unmanaged resources. 
//
public ref class MyResource: public IDisposable
{
private:

   // Pointer to an external unmanaged resource.
   IntPtr handle;

   // A managed resource this class uses.
   Component^ component;

   // Track whether Dispose has been called.
   bool disposed;

public:
   // The class constructor.
   MyResource( IntPtr handle, Component^ component )
   {
      this->handle = handle;
      this->component = component;
      disposed = false;
   }

   // This method is called if the user explicitly disposes of the
   // object (by calling the Dispose method in other managed languages, 
   // or the destructor in C++). The compiler emits as a call to 
   // GC::SuppressFinalize( this ) for you, so there is no need to 
   // call it here.
   ~MyResource() 
   {
      // Dispose of managed resources.
      component->~Component();

      // Call C++ finalizer to clean up unmanaged resources.
      this->!MyResource();

      // Mark the class as disposed. This flag allows you to throw an
      // exception if a disposed object is accessed.
      disposed = true;
   }

   // Use interop to call the method necessary to clean up the 
   // unmanaged resource.
   //
   [System::Runtime::InteropServices::DllImport("Kernel32")]
   static Boolean CloseHandle( IntPtr handle );

   // The C++ finalizer destructor ensures that unmanaged resources get
   // released if the user releases the object without explicitly 
   // disposing of it.
   //
   !MyResource()
   {      
      // Call the appropriate methods to clean up unmanaged 
      // resources here. If disposing is false when Dispose(bool,
      // disposing) is called, only the following code is executed.
      CloseHandle( handle );
      handle = IntPtr::Zero;
   }

};

void main()
{
   // Insert code here to create and use the MyResource object.
   MyResource^ mr = gcnew MyResource((IntPtr) 42, (Component^) gcnew Button());
   mr->~MyResource();
}
using System;
using System.ComponentModel;

// The following example demonstrates how to create
// a resource class that implements the IDisposable interface
// and the IDisposable.Dispose method.

public class DisposeExample
{
    // A base class that implements IDisposable.
    // By implementing IDisposable, you are announcing that
    // instances of this type allocate scarce resources.
    public class MyResource: IDisposable
    {
        // Pointer to an external unmanaged resource.
        private IntPtr handle;
        // Other managed resource this class uses.
        private Component component = new Component();
        // Track whether Dispose has been called.
        private bool disposed = false;

        // The class constructor.
        public MyResource(IntPtr handle)
        {
            this.handle = handle;
        }

        // Implement IDisposable.
        // Do not make this method virtual.
        // A derived class should not be able to override this method.
        public void Dispose()
        {
            Dispose(disposing: true);
            // This object will be cleaned up by the Dispose method.
            // Therefore, you should call GC.SuppressFinalize to
            // take this object off the finalization queue
            // and prevent finalization code for this object
            // from executing a second time.
            GC.SuppressFinalize(this);
        }

        // Dispose(bool disposing) executes in two distinct scenarios.
        // If disposing equals true, the method has been called directly
        // or indirectly by a user's code. Managed and unmanaged resources
        // can be disposed.
        // If disposing equals false, the method has been called by the
        // runtime from inside the finalizer and you should not reference
        // other objects. Only unmanaged resources can be disposed.
        protected virtual void Dispose(bool disposing)
        {
            // Check to see if Dispose has already been called.
            if(!this.disposed)
            {
                // If disposing equals true, dispose all managed
                // and unmanaged resources.
                if(disposing)
                {
                    // Dispose managed resources.
                    component.Dispose();
                }

                // Call the appropriate methods to clean up
                // unmanaged resources here.
                // If disposing is false,
                // only the following code is executed.
                CloseHandle(handle);
                handle = IntPtr.Zero;

                // Note disposing has been done.
                disposed = true;
            }
        }

        // Use interop to call the method necessary
        // to clean up the unmanaged resource.
        [System.Runtime.InteropServices.DllImport("Kernel32")]
        private extern static Boolean CloseHandle(IntPtr handle);

        // Use C# finalizer syntax for finalization code.
        // This finalizer will run only if the Dispose method
        // does not get called.
        // It gives your base class the opportunity to finalize.
        // Do not provide finalizer in types derived from this class.
        ~MyResource()
        {
            // Do not re-create Dispose clean-up code here.
            // Calling Dispose(disposing: false) is optimal in terms of
            // readability and maintainability.
            Dispose(disposing: false);
        }
    }
    public static void Main()
    {
        // Insert code here to create
        // and use the MyResource object.
    }
}
Imports System.ComponentModel

' The following example demonstrates how to create
' a resource class that implements the IDisposable interface
' and the IDisposable.Dispose method.
Public Class DisposeExample

   ' A class that implements IDisposable.
   ' By implementing IDisposable, you are announcing that
   ' instances of this type allocate scarce resources.
   Public Class MyResource
      Implements IDisposable
      ' Pointer to an external unmanaged resource.
      Private handle As IntPtr
      ' Other managed resource this class uses.
      Private component As component
      ' Track whether Dispose has been called.
      Private disposed As Boolean = False

      ' The class constructor.
      Public Sub New(ByVal handle As IntPtr)
         Me.handle = handle
      End Sub

      ' Implement IDisposable.
      ' Do not make this method virtual.
      ' A derived class should not be able to override this method.
      Public Overloads Sub Dispose() Implements IDisposable.Dispose
         Dispose(disposing:=True)
         ' This object will be cleaned up by the Dispose method.
         ' Therefore, you should call GC.SupressFinalize to
         ' take this object off the finalization queue
         ' and prevent finalization code for this object
         ' from executing a second time.
         GC.SuppressFinalize(Me)
      End Sub

      ' Dispose(bool disposing) executes in two distinct scenarios.
      ' If disposing equals true, the method has been called directly
      ' or indirectly by a user's code. Managed and unmanaged resources
      ' can be disposed.
      ' If disposing equals false, the method has been called by the
      ' runtime from inside the finalizer and you should not reference
      ' other objects. Only unmanaged resources can be disposed.
      Protected Overridable Overloads Sub Dispose(ByVal disposing As Boolean)
         ' Check to see if Dispose has already been called.
         If Not Me.disposed Then
            ' If disposing equals true, dispose all managed
            ' and unmanaged resources.
            If disposing Then
               ' Dispose managed resources.
               component.Dispose()
            End If

            ' Call the appropriate methods to clean up
            ' unmanaged resources here.
            ' If disposing is false,
            ' only the following code is executed.
            CloseHandle(handle)
            handle = IntPtr.Zero

            ' Note disposing has been done.
            disposed = True

         End If
      End Sub

      ' Use interop to call the method necessary
      ' to clean up the unmanaged resource.
      <System.Runtime.InteropServices.DllImport("Kernel32")> _
      Private Shared Function CloseHandle(ByVal handle As IntPtr) As [Boolean]
      End Function

      ' This finalizer will run only if the Dispose method
      ' does not get called.
      ' It gives your base class the opportunity to finalize.
      ' Do not provide finalize methods in types derived from this class.
      Protected Overrides Sub Finalize()
         ' Do not re-create Dispose clean-up code here.
         ' Calling Dispose(disposing:=False) is optimal in terms of
         ' readability and maintainability.
         Dispose(disposing:=False)
         MyBase.Finalize()
      End Sub
   End Class

   Public Shared Sub Main()
      ' Insert code here to create
      ' and use the MyResource object.
   End Sub

End Class

Remarques

Utilisez cette méthode pour fermer ou libérer des ressources non managées telles que les fichiers, les flux et les handles détenus par une instance de la classe qui implémente cette interface. Par Convention, cette méthode est utilisée pour toutes les tâches associées à la libération de ressources détenues par un objet ou à la préparation d’un objet en vue de sa réutilisation.

Avertissement

Si vous utilisez une classe qui implémente l' IDisposable interface, vous devez appeler son Dispose implémentation lorsque vous avez fini d’utiliser la classe. Pour plus d’informations, consultez la section « utilisation d’un objet qui implémente IDisposable » dans la IDisposable rubrique.

Lors de l’implémentation de cette méthode, assurez-vous que toutes les ressources détenues sont libérées en propageant l’appel via la hiérarchie de relation contenant-contenu. Par exemple, si un objet A alloue un objet B, et que l’objet B alloue un objet C, l’implémentation de A Dispose doit appeler Dispose sur B, qui doit à son tour être appelé Dispose sur C.

Important

Le compilateur C++ prend en charge la suppression déterministe de ressources et n’autorise pas l’implémentation directe de la Dispose méthode.

Un objet doit également appeler la Dispose méthode de sa classe de base si la classe de base implémente IDisposable . Pour plus d’informations sur IDisposable l’implémentation de sur une classe de base et ses sous-classes, consultez la section « IDisposable et la hiérarchie d’héritage » dans la IDisposable rubrique.

Si la méthode d’un objet Dispose est appelée plusieurs fois, l’objet doit ignorer tous les appels après le premier. L’objet ne doit pas lever d’exception si sa Dispose méthode est appelée plusieurs fois. Les méthodes d’instance autres que Dispose peuvent lever une exception ObjectDisposedException lorsque des ressources sont déjà supprimées.

Les utilisateurs peuvent s’attendre à ce qu’un type de ressource utilise une convention particulière pour indiquer un État alloué et un État libéré. Par exemple, les classes de flux, qui sont généralement considérées comme étant ouvertes ou fermées. L’implémenteur d’une classe qui a une telle convention peut choisir d’implémenter une méthode publique avec un nom personnalisé, tel que Close , qui appelle la Dispose méthode.

Étant donné que la Dispose méthode doit être appelée explicitement, il y a toujours un danger que les ressources non managées ne seront pas libérées, car le consommateur d’un objet ne parvient pas à appeler sa Dispose méthode. Vous disposez de deux méthodes pour éviter cette situation :

  • Encapsulez la ressource managée dans un objet dérivé de System.Runtime.InteropServices.SafeHandle . Votre Dispose implémentation appelle ensuite la Dispose méthode des System.Runtime.InteropServices.SafeHandle instances. Pour plus d’informations, consultez la section « alternative de SafeHandle » dans la Object.Finalize rubrique.

  • Implémentez un finaliseur pour libérer des ressources lorsque Dispose n’est pas appelé. Par défaut, le garbage collector appelle automatiquement le finaliseur d’un objet avant de récupérer sa mémoire. Toutefois, si la Dispose méthode a été appelée, il est généralement inutile que le garbage collector appelle le finaliseur de l’objet supprimé. Pour empêcher la finalisation automatique, Dispose les implémentations peuvent appeler la GC.SuppressFinalize méthode.

Lorsque vous utilisez un objet qui accède à des ressources non managées, comme un StreamWriter , il est recommandé de créer l’instance avec une using instruction. L' using instruction ferme automatiquement le flux et appelle Dispose sur l’objet lorsque le code qui l’utilise est terminé. Pour obtenir un exemple, consultez la StreamWriter classe.

S’applique à

Voir aussi