Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Dispose Method (Boolean)
Collapse the table of content
Expand the table of content

Stream.Dispose Method (Boolean)

Releases the unmanaged resources used by the Stream and optionally releases the managed resources.

Namespace:  System.IO
Assemblies:   mscorlib (in mscorlib.dll)
  System.IO (in System.IO.dll)

protected virtual void Dispose(
	bool disposing
)

Parameters

disposing
Type: System.Boolean

true to release both managed and unmanaged resources; false to release only unmanaged resources.

You should release all resources by specifying true for disposing. When disposing is true, the stream can also ensure data is flushed to the underlying buffer, and access other finalizable objects. This may not be possible when called from a finalizer due a lack of ordering among finalizers.

If your stream is using an operating system handle to communicate with its source, consider using a subclass of SafeHandle for this purpose.

This method is called by the public Dispose method and the Finalize method. Dispose invokes the protected Dispose method with the disposing parameter set to true. Finalize invokes Dispose with disposing set to false.

Notes to Inheritors

In derived classes, do not override the Close method, instead, put all of the Stream cleanup logic in the Dispose method.

Dispose can be called multiple times by other objects. When overriding Dispose, be careful not to reference objects that have been previously disposed of in an earlier call to Dispose. For more information about how to implement Dispose, see Implementing a Dispose Method.

For more information about Dispose and Finalize, see Cleaning Up Unmanaged Resources.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone Silverlight 8.1, Windows Phone Silverlight 8

Portable Class Library

Supported in: Portable Class Library
Show:
© 2015 Microsoft