IDisposable.Dispose Metodo

Definizione

Spazio dei nomi:

System

Assembly:

netstandard.dll, System.Runtime.dll

Esegue attività definite dall'applicazione, come rilasciare o reimpostare risorse non gestite.

C#

public void Dispose();

Esempio

Nell'esempio seguente viene illustrato come implementare il Dispose metodo.

C#

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.
    }
}

Commenti

Usare questo metodo per chiudere o rilasciare risorse non gestite, ad esempio file, flussi e handle mantenuti da un'istanza della classe che implementa questa interfaccia. Per convenzione, questo metodo viene usato per tutte le attività associate alla liberazione delle risorse contenute da un oggetto o per preparare un oggetto per il riutilizzo.

Avviso

Se si usa una classe che implementa l'interfaccia, è necessario chiamare la relativa Dispose implementazione al termine dell'uso IDisposable della classe. Per altre informazioni, vedere la sezione "Uso di un oggetto che implementa IDisposable" nell'argomento IDisposable .

Quando si implementa questo metodo, assicurarsi che tutte le risorse mantenute vengano liberate propagando la chiamata tramite la gerarchia di contenimento. Ad esempio, se un oggetto A alloca un oggetto B e un oggetto B alloca un oggetto C, l'implementazione di Dispose A deve chiamare Dispose su B, che deve attivare la chiamata Dispose a C.

Importante

Il compilatore C++ supporta lo smaltimento deterministico delle risorse e non consente l'implementazione diretta del Dispose metodo.

Un oggetto deve anche chiamare il Dispose metodo della classe base se la classe base implementa IDisposable. Per altre informazioni sull'implementazione IDisposable in una classe di base e sulle relative sottoclassi, vedere la sezione "IDisposable e la gerarchia di ereditarietà" nell'argomento IDisposable .

Se il metodo di Dispose un oggetto viene chiamato più volte, l'oggetto deve ignorare tutte le chiamate dopo la prima. L'oggetto non deve generare un'eccezione se il Dispose relativo metodo viene chiamato più volte. I metodi di istanza diversi da Dispose possono generare un ObjectDisposedException oggetto quando le risorse sono già eliminate.

Gli utenti potrebbero prevedere che un tipo di risorsa usi una convenzione specifica per indicare uno stato allocato rispetto a uno stato libero. Un esempio di questo è le classi di flusso, che tradizionalmente vengono considerate come aperte o chiuse. L'implementazione di una classe con tale convenzione potrebbe scegliere di implementare un metodo pubblico con un nome personalizzato, ad esempio Close, che chiama il Dispose metodo .

Poiché il Dispose metodo deve essere chiamato in modo esplicito, esiste sempre un pericolo che le risorse non gestite non vengano rilasciate, perché il consumer di un oggetto non riesce a chiamare il Dispose relativo metodo. Per evitare questo problema, è possibile procedere in due modi:

• Eseguire il wrapping della risorsa gestita in un oggetto derivato da System.Runtime.InteropServices.SafeHandle. L'implementazione Dispose chiama quindi il Dispose metodo delle System.Runtime.InteropServices.SafeHandle istanze. Per altre informazioni, vedere la sezione "The SafeHandle alternative" nell'argomento Object.Finalize .

• Implementare un finalizzatore per liberare risorse quando Dispose non viene chiamato. Per impostazione predefinita, Garbage Collector chiama automaticamente il finalizzatore di un oggetto prima di recuperare la memoria. Tuttavia, se il Dispose metodo è stato chiamato, in genere non è necessario che il Garbage Collector chiami il finalizzatore dell'oggetto eliminato. Per evitare la finalizzazione automatica, Dispose le implementazioni possono chiamare il GC.SuppressFinalize metodo.

Quando si usa un oggetto che accede alle risorse non gestite, ad esempio , StreamWriterè consigliabile creare l'istanza con un'istruzione using . L'istruzione using chiude automaticamente il flusso e chiama Dispose l'oggetto quando il codice che lo usa è stato completato. Per un esempio, vedere la StreamWriter classe .

Si applica a

Vedi anche

• Implementazione di un metodo Dispose