SerialPort Members
.NET Framework 3.5
Represents a serial port resource.
The SerialPort type exposes the following members.
| Name | Description | |
|---|---|---|
|
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 | Overloaded. Releases the unmanaged resources used by the SerialPort object. |
|
|
Equals | 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 a hash function for a particular type. (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 | Overloaded. |
|
|
Open | Opens a new serial port connection. |
|
|
Read | Overloaded. Reads from the SerialPort input buffer. |
|
|
ReadByte | Synchronously reads one byte from the SerialPort input buffer. |
|
|
ReadChar | Synchronously reads one character from the SerialPort input buffer. |
|
|
ReadExisting | Reads all immediately available bytes, based on the encoding, in both the stream and the input buffer of the SerialPort 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.) In .NET Compact Framework 3.5, this member is inherited from Object.ToString(). |
|
|
Write | Overloaded. Writes data to the serial port output buffer. |
|
|
WriteLine | Writes the specified string and the NewLine value to the output buffer. |
| Name | Description | |
|---|---|---|
|
|
BaseStream | Gets the underlying Stream object for a SerialPort 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 SerialPort 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 SerialPort 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. |
| Name | Description | |
|---|---|---|
|
|
DataReceived | Represents the method that will handle the data received event of a SerialPort 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 SerialPort object. |
|
|
PinChanged | Represents the method that will handle the serial pin changed event of a SerialPort object. |
