This documentation is archived and is not being maintained.

TextWriter.Dispose Method

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

[Visual Basic]
Protected Overridable Sub Dispose( _
   ByVal disposing As Boolean _
)
[C#]
protected virtual void Dispose(
 bool disposing
);
[C++]
protected: virtual void Dispose(
 bool disposing
);
[JScript]
protected function Dispose(
   disposing : Boolean
);

Parameters

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

Remarks

This method is called by Dispose and Finalize. By default, this method specifies the disposing parameter as true. Finalize specifies the disposing parameter as false.

When the disposing parameter is true, this method releases all resources held by any managed objects that this TextWriter references. This method invokes the Dispose method of each referenced object.

Notes to Inheritors:   TextWriter.Dispose can be called multiple times by other objects. When overriding this method, 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 this method, see Implementing a Dispose Method.

For more information about IDisposable.Dispose and Finalize, see Cleaning Up Unmanaged Resources and Overriding the Finalize Method.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework, Common Language Infrastructure (CLI) Standard

See Also

TextWriter Class | TextWriter Members | System.IO Namespace | Working with I/O | Reading Text from a File | Writing Text to a File

Show: