Click or drag to resize

ISerialPort Interface

[This is preliminary documentation and is subject to change.]

Defines the Serial Port capability

Namespace:  GHASchema.Classes.Capabilities.InputOutput
Assembly:  GHASchema (in GHASchema.dll) Version: 1.1.8074.31450 (1.0.0.0)
Syntax
C#
[GHACapabilityAttribute("InputOutput", "")]
public interface ISerialPort

The ISerialPort type exposes the following members.

Properties
  NameDescription
Public propertyBaudRate
Defines the speed (baud rate) for the serial port
Public propertyBytesAvailable
Number of bytes available in the read stream
Public propertyCTS
Sets the Clear to send bit
Public propertyDataBits
Defines the number of data bits to use for the serial port
Public propertyDataReceived
Momentary, set when new data is available from the serial port.
Public propertyDSR
Sets the Data Set Ready bit
Public propertyDTR
Sets the Data Terminal Ready bit
Public propertyEndOfMessageMarker
Defines the character that the driver will use to determine if a received message is complete
Public propertyErrorReceived
Momentary, set when the serial port detects an error
Public propertyFlowControl
Defines the desired flow-control for the serial port
Public propertyIsOpen
Determines if serial port is in-use (true) or available (false)
Public propertyIsTextOriented
Determines if the serial port exclusively sends standard printable characters (true) versus binary (false)
Public propertyParity
Defines the parity setting for the serial port
Public propertyReset
Momentary, initiates a reset of the port
Public propertyRTS
Sets the request to send bit
Public propertyStatusCTS
Reads the status of the Clear to send bit
Public propertyStatusDSR
Reads the status of the Data set ready bit
Public propertyStatusRing
Reads the status of the Ring bit
Public propertyStopBits
Defines the number of stop bits for the serial port
Top
Methods
  NameDescription
Public methodClose
Closes the serial port
Public methodOpen
Opens the serial port
Public methodRead
Reads data from the serial port
Public methodReadLine
Reads a line of text from the serial port
Public methodWrite(String)
Writes a line of text without a terminator character
Public methodWrite(Byte, Int32, Int32)
Writes a byte buffer to the serial port
Public methodWriteLine
Writes a line of text to the serial port with a termination character
Top
See Also