SerialPort.ReadTo(String) Method

Definition

Namespace:

System.IO.Ports

Assembly:

System.IO.Ports.dll

Package:

System.IO.Ports v9.0.0-rc.2.24473.5

Source:

SerialPort.cs

Reads a string up to the specified value in the input buffer.

public:
 System::String ^ ReadTo(System::String ^ value);

public string ReadTo (string value);

member this.ReadTo : string -> string

Public Function ReadTo (value As String) As String

Parameters

value

String

A value that indicates where the read operation stops.

Returns

String

The contents of the input buffer up to the specified value.

Exceptions

ArgumentException

The length of the value parameter is 0.

ArgumentNullException

The value parameter is null.

InvalidOperationException

The specified port is not open.

TimeoutException

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

Remarks

This method reads a string up to the specified value. While the returned string does not include the value, the 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.

Note

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.