Represents a serial port resource.
To browse the .NET Framework source code for this type, see the Reference Source.
Assembly: System (in System.dll)
Thetype exposes the following members.
|SerialPort()||Initializes a new instance of the class.|
|SerialPort(IContainer)||Initializes a new instance of the class using the specified IContainer object.|
|SerialPort(String)||Initializes a new instance of the class using the specified port name.|
|SerialPort(String, Int32)||Initializes a new instance of the class using the specified port name and baud rate.|
|SerialPort(String, Int32, Parity)||Initializes a new instance of the class using the specified port name, baud rate, and parity bit.|
|SerialPort(String, Int32, Parity, Int32)||Initializes a new instance of the class using the specified port name, baud rate, parity bit, and data bits.|
|SerialPort(String, Int32, Parity, Int32, StopBits)||Initializes a new instance of the class using the specified port name, baud rate, parity bit, data bits, and stop bit.|
|BaseStream||Gets the underlying Stream object for a object.|
|BaudRate||Gets or sets the serial baud rate.|
|BreakState||Gets or sets the break signal state.|
|BytesToRead||Gets the number of bytes of data in the receive buffer.|
|BytesToWrite||Gets the number of bytes of data in the send buffer.|
|CanRaiseEvents||Gets a value indicating whether the component can raise an event. (Inherited from Component.)|
|CDHolding||Gets the state of the Carrier Detect line for the port.|
|Container||Gets the IContainer that contains the Component. (Inherited from Component.)|
|CtsHolding||Gets the state of the Clear-to-Send line.|
|DataBits||Gets or sets the standard length of data bits per byte.|
|DesignMode||Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)|
|DiscardNull||Gets or sets a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer.|
|DsrHolding||Gets the state of the Data Set Ready (DSR) signal.|
|DtrEnable||Gets or sets a value that enables the Data Terminal Ready (DTR) signal during serial communication.|
|Encoding||Gets or sets the byte encoding for pre- and post-transmission conversion of text.|
|Events||Gets the list of event handlers that are attached to this Component. (Inherited from Component.)|
|Handshake||Gets or sets the handshaking protocol for serial port transmission of data.|
|IsOpen||Gets a value indicating the open or closed status of the object.|
|NewLine||Gets or sets the value used to interpret the end of a call to the ReadLine and WriteLine methods.|
|Parity||Gets or sets the parity-checking protocol.|
|ParityReplace||Gets or sets the byte that replaces invalid bytes in a data stream when a parity error occurs.|
|PortName||Gets or sets the port for communications, including but not limited to all available COM ports.|
|ReadBufferSize||Gets or sets the size of the input buffer.|
|ReadTimeout||Gets or sets the number of milliseconds before a time-out occurs when a read operation does not finish.|
|ReceivedBytesThreshold||Gets or sets the number of bytes in the internal input buffer before a DataReceived event occurs.|
|RtsEnable||Gets or sets a value indicating whether the Request to Send (RTS) signal is enabled during serial communication.|
|Site||Gets or sets the ISite of the Component. (Inherited from Component.)|
|StopBits||Gets or sets the standard number of stopbits per byte.|
|WriteBufferSize||Gets or sets the size of the serial port output buffer.|
|WriteTimeout||Gets or sets the number of milliseconds before a time-out occurs when a write operation does not finish.|
|Close||Closes the port connection, sets the IsOpen property to false, and disposes of the internal Stream object.|
|CreateObjRef||Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)|
|DiscardInBuffer||Discards data from the serial driver's receive buffer.|
|DiscardOutBuffer||Discards data from the serial driver's transmit buffer.|
|Dispose()||Releases all resources used by the Component. (Inherited from Component.)|
|Dispose(Boolean)||Releases the unmanaged resources used by the and optionally releases the managed resources. (Overrides Component.Dispose(Boolean).)|
|Equals(Object)||Determines whether the specified object is equal to the current object. (Inherited from Object.)|
|Finalize||Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)|
|GetHashCode||Serves as the default hash function. (Inherited from Object.)|
|GetLifetimeService||Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)|
|GetPortNames||Gets an array of serial port names for the current computer.|
|GetService||Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)|
|GetType||Gets the Type of the current instance. (Inherited from Object.)|
|InitializeLifetimeService||Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)|
|MemberwiseClone()||Creates a shallow copy of the current Object. (Inherited from Object.)|
|MemberwiseClone(Boolean)||Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)|
|Open||Opens a new serial port connection.|
|Read(Byte, Int32, Int32)||Reads a number of bytes from the input buffer and writes those bytes into a byte array at the specified offset.|
|Read(Char, Int32, Int32)||Reads a number of characters from the input buffer and writes them into an array of characters at a given offset.|
|ReadByte||Synchronously reads one byte from the input buffer.|
|ReadChar||Synchronously reads one character from the input buffer.|
|ReadExisting||Reads all immediately available bytes, based on the encoding, in both the stream and the input buffer of the object.|
|ReadLine||Reads up to the NewLine value in the input buffer.|
|ReadTo||Reads a string up to the specified value in the input buffer.|
|ToString||Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)|
|Write(String)||Writes the specified string to the serial port.|
|Write(Byte, Int32, Int32)||Writes a specified number of bytes to the serial port using data from a buffer.|
|Write(Char, Int32, Int32)||Writes a specified number of characters to the serial port using data from a buffer.|
|WriteLine||Writes the specified string and the NewLine value to the output buffer.|
|DataReceived||Represents the method that will handle the data received event of a object.|
|Disposed||Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)|
|ErrorReceived||Represents the method that handles the error event of a object.|
|PinChanged||Represents the method that will handle the serial pin changed event of a object.|
To view the .NET Framework source code for this type, see the Reference Source. You can browse through the source code online, download the reference for offline viewing, and step through the sources (including patches and updates) during debugging; see instructions.
Use this class to control a serial port file resource. This class provides synchronous and event-driven I/O, access to pin and break states, and access to serial driver properties. Additionally, the functionality of this class can be wrapped in an internal Stream object, accessible through the BaseStream property, and passed to classes that wrap or use streams.
The class supports the following encodings: ASCIIEncoding, UTF8Encoding, UnicodeEncoding, UTF32Encoding, and any encoding defined in mscorlib.dll where the code page is less than 50000 or the code page is 54936. You can use alternate encodings, but you must use the ReadByte or Write method and perform the encoding yourself.
You use the GetPortNames method to retrieve the valid ports for the current computer.
If a object becomes blocked during a read operation, do not abort the thread. Instead, either close the base stream or dispose of the object.
The following code example demonstrates the use of the class to allow two users to chat from two separate computers connected by a null modem cable. In this example, the users are prompted for the port settings and a username before chatting. Both computers must be executing the program to achieve full functionality of this example.
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.