Export (0) Print
Expand All

SerialPort.Dispose Method (Boolean)

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

Namespace:  System.IO.Ports
Assembly:  System (in System.dll)

protected override void Dispose(
	bool disposing
)

Parameters

disposing
Type: System.Boolean

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

ExceptionCondition
IOException

The port is in an invalid state.

- or -

An attempt to set the state of the underlying port failed. For example, the parameters passed from this SerialPort object were invalid.

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.

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

This method flushes and closes the stream object in the BaseStream property.

Notes to Inheritors

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.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft