Windows apps
Collapse the table of content
Expand the table of content

Dispose Method (Boolean)

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

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.

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.

Show:
© 2017 Microsoft