This documentation is archived and is not being maintained.

SerialPort.ReadChar Method

Synchronously reads one character from the SerialPort input buffer.

Namespace:  System.IO.Ports
Assembly:  System (in System.dll)

public int ReadChar()

Return Value

Type: System.Int32
The character that was read.

ExceptionCondition
InvalidOperationException

The specified port is not open.

TimeoutException

The operation did not complete before the time-out period ended.

- or -

No character was available in the allotted time-out period.

This method reads one complete character based on the encoding.

Use caution when using ReadByte and ReadChar together. Switching between reading bytes and reading characters can cause extra data to be read and/or other unintended behavior. If it is necessary to switch between reading text and reading binary data from the stream, select a protocol that carefully defines the boundary between text and binary data, such as manually reading bytes and decoding the data.

NoteNote:

Because the SerialPort class buffers data, and the stream contained in the BaseStream property does not, the two might conflict about how many bytes are available to read. The BytesToRead property can indicate that there are bytes to read, but these bytes might not be accessible to the stream contained in the BaseStream property because they have been buffered to the SerialPort class.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

.NET Compact Framework

Supported in: 3.5, 2.0
Show: