ReadLine Method

SerialPort.ReadLine Method

Note: This method is new in the .NET Framework version 2.0.

Reads up to the NewLine value in the input buffer.

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

public string ReadLine ()
public String ReadLine ()
public function ReadLine () : String

Return Value

The contents of the input buffer up to the first occurrence of a NewLine value.

Exception typeCondition

InvalidOperationException

The specified port is not open.

TimeoutException

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

- or -

No bytes were read.

Note that while this method does not return the NewLine value, the NewLine value is removed from the input buffer.

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.

The following code example demonstrates the use of the SerialPort class to allow two users to chat from two separate computers connected by a null modem cable. This code example is part of a larger code example provided for the SerialPort class.

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

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

.NET Framework

Supported in: 2.0

.NET Compact Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2016 Microsoft