ObjectDisposedException Class (System)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
ObjectDisposedException Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

The exception that is thrown when an operation is performed on a disposed object.

Inheritance Hierarchy
System.Object
  System.Exception
    System.SystemException
      System.InvalidOperationException
        System.ObjectDisposedException

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)
Syntax
Visual Basic
<SerializableAttribute> _
<ComVisibleAttribute(True)> _
Public Class ObjectDisposedException _
	Inherits InvalidOperationException
C#
[SerializableAttribute]
[ComVisibleAttribute(true)]
public class ObjectDisposedException : InvalidOperationException
Visual C++
[SerializableAttribute]
[ComVisibleAttribute(true)]
public ref class ObjectDisposedException : public InvalidOperationException
F#
[<SerializableAttribute>]
[<ComVisibleAttribute(true)>]
type ObjectDisposedException =  
    class
        inherit InvalidOperationException
    end

The ObjectDisposedException type exposes the following members.

Constructors
  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library ObjectDisposedException(String) Initializes a new instance of the ObjectDisposedException class with a string containing the name of the disposed object.
Protected method ObjectDisposedException(SerializationInfo, StreamingContext) Initializes a new instance of the ObjectDisposedException class with serialized data.
Public method Supported by Portable Class Library ObjectDisposedException(String, Exception) Initializes a new instance of the ObjectDisposedException class with a specified error message and a reference to the inner exception that is the cause of this exception.
Public method Supported by the XNA Framework Supported by Portable Class Library ObjectDisposedException(String, String) Initializes a new instance of the ObjectDisposedException class with the specified object name and message.
Top
Properties
  Name Description
Public property Data Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
Public property HelpLink Gets or sets a link to the help file associated with this exception. (Inherited from Exception.)
Public property Supported by the XNA Framework Supported by Portable Class Library HResult Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
Public property Supported by the XNA Framework Supported by Portable Class Library InnerException Gets the Exception instance that caused the current exception. (Inherited from Exception.)
Public property Supported by the XNA Framework Supported by Portable Class Library Message Gets the message that describes the error. (Overrides Exception.Message.)

In XNA Framework 3.0, this member is inherited from Exception.Message.

In Portable Class Library Portable Class Library, this member is inherited from Exception.Message.
Public property Supported by the XNA Framework Supported by Portable Class Library ObjectName Gets the name of the disposed object.
Public property Source Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
Public property Supported by the XNA Framework Supported by Portable Class Library StackTrace Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
Public property TargetSite Gets the method that throws the current exception. (Inherited from Exception.)
Top
Methods
  Name Description
Public method Supported by the XNA Framework Supported by Portable Class Library Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Supported by the XNA Framework Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetBaseException When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
Public method Supported by the XNA Framework Supported by Portable Class Library GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetObjectData Retrieves the SerializationInfo object with the parameter name and additional exception information. (Overrides Exception.GetObjectData(SerializationInfo, StreamingContext).)
Public method Supported by the XNA Framework Supported by Portable Class Library GetType Gets the runtime type of the current instance. (Inherited from Exception.)

In XNA Framework 3.0, this member is inherited from Object.GetType().

In Portable Class Library Portable Class Library, this member is inherited from Object.GetType().
Protected method Supported by the XNA Framework Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Supported by the XNA Framework Supported by Portable Class Library ToString Creates and returns a string representation of the current exception. (Inherited from Exception.)
Top
Events
  Name Description
Protected event SerializeObjectState Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.)
Top
Examples

The following example demonstrates an error that causes the ObjectDisposedException exception to be thrown.

Visual Basic

Imports System
Imports System.IO

Public Class ObjectDisposedExceptionTest

   Public Shared Sub Main()
      Dim ms As New MemoryStream(16)
      ms.Close()
      Try
         ms.ReadByte()
      Catch e As ObjectDisposedException
         Console.WriteLine("Caught: {0}", e.Message)
      End Try
   End Sub 'Main
End Class 'ObjectDisposedExceptionTest
C#

using System;
using System.IO;

public class ObjectDisposedExceptionTest 
{
   public static void Main()
   {     
      MemoryStream ms = new MemoryStream(16);
      ms.Close();
      try 
      {
         ms.ReadByte();
      } 
      catch (ObjectDisposedException e) 
      {
         Console.WriteLine("Caught: {0}", e.Message);
      }
   }
}
Visual C++

using namespace System;
using namespace System::IO;
int main()
{
   MemoryStream^ ms = gcnew MemoryStream( 16 );
   ms->Close();
   try
   {
      ms->ReadByte();
   }
   catch ( ObjectDisposedException^ e ) 
   {
      Console::WriteLine( "Caught: {0}", e->Message );
   }

}

This code produces the following output: 

Caught:
  Cannot access a closed Stream.
Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library
Platforms

Windows 8 Consumer Preview, Windows Server 8 Beta, Windows 7, Windows Server 2008 SP2, Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

System Namespace
IDisposable