SerialPort Class

SerialPort Class

Mono implementation of SerialPort is incomplete. This is to make up for that.

Inheritance Hierarchy

SystemObject
SerialPortNETSerialPort

Namespace: SerialPortNET
Assembly: SerialPortNET (in SerialPortNET.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public class SerialPort : ISerialPort, IDisposable

Public Class SerialPort
	Implements ISerialPort, IDisposable

public ref class SerialPort : ISerialPort, 
	IDisposable

type SerialPort =  
    class
        interface ISerialPort
        interface IDisposable
    end

The SerialPort type exposes the following members.

Constructors

	Name	Description
	SerialPort	Creates a new Serial Port

Properties

	Name	Description
	BaudRate	Gets or sets the serial baud rate.
	BytesToRead	Gets the number of bytes of data in the receive buffer.
	BytesToWrite	Gets the number of bytes of data in the send buffer.
	DataBits	Gets or sets the standard length of data bits per byte.
	DtrControl	Gets or sets a value that enables the Data Terminal Ready (DTR) signal during serial communication.
	IsOpen	Gets a value indicating the open or closed status of the SerialPort object.
	IsRunning	Gets a value indicating the running status of the SerialPort object.
	Parity	Gets or sets the parity-checking protocol.
	PortName	Gets or sets the port for communications, including but not limited to all available COM ports.
	ReceivedBytesThreshold	Gets or sets the number of bytes in the internal input buffer before a DataReceived event occurs.
	StopBits	Gets or sets the standard number of stop bits per byte.

Methods

	Name	Description
	Close	Closes this serial port instance
	Dispose	Called when this object is disposed
	Dispose(Boolean)	Gets called when this instance is disposed.
	EnumerateSerialPorts	Enumerate all the serial ports and their respected device name by accessing the registry.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnDataReceived	If RunAsync() is called, this method is called when new data is available in the input buffer of the serial port.
	Open	Opens the port.
	Read	Reads a number of bytes from the SerialPort input buffer and writes those bytes into a byte array at the specified offset.
	ReadAll	Reads all bytes from the SerialPort input buffer.
	RunAsync	Run asynchronous operation.
	StopAsync	Stop the asynchronous operation.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Write	Writes a specified number of bytes to the serial port using data from a buffer.
	WriteAll	Writes all bytes to the serial port.

Events

	Name	Description
	DataReceived	If RunAsync() is called, this event is raised when new data is available in the input buffer of the serial port.