SerialPort.Dispose(Boolean) Method

Definition

Namespace:

System.IO.Ports

Assembly:

System.IO.Ports.dll

Package:

System.IO.Ports v9.0.0-rc.2.24473.5

Source:

SerialPort.cs

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

protected:
 override void Dispose(bool disposing);

protected override void Dispose (bool disposing);

override this.Dispose : bool -> unit

Protected Overrides Sub Dispose (disposing As Boolean)

Parameters

disposing

Boolean

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

Exceptions

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.

Remarks

This method is called by the public Dispose() method and the Finalize() method, if it has been overridden. 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(Boolean), 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(Boolean), see Implementing a Dispose Method.

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