Export (0) Print
Expand All

Stream.Dispose Method (Boolean)

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

Namespace:  System.IO
Assembly:  mscorlib (in mscorlib.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 and Overriding the Finalize Method.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

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

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), 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.

Show:
© 2014 Microsoft