SerialPort.ReadTo(String) Метод

Определение

Считывает из входного буфера строку до указанного значения value.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

Параметры

value
String

Значение, указывающее место прекращения операции чтения.A value that indicates where the read operation stops.

Возвраты

Содержимое входного буфера до указанного value.The contents of the input buffer up to the specified value.

Исключения

Длина параметра value равна 0.The length of the value parameter is 0.

Параметр value имеет значение null.The value parameter is null.

Указанный порт не открыт.The specified port is not open.

Операция не была завершена до истечения срока ожидания.The operation did not complete before the time-out period ended.

Комментарии

Этот метод считывает строку вплоть до указанного value.This method reads a string up to the specified value. Хотя возвращаемая строка не включает value 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.

Примечание

BaseStream Так как SerialPort класс помещает данные в буфер, а поток, содержащийся в свойстве, не имеет значения, два могут конфликтовать с тем, сколько байтов доступно для чтения.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. Свойство может означать, что есть байты для чтения, но эти байты могут быть недоступны для потока, содержащегося BaseStream в свойстве, так как они SerialPort были помещены в буфер класса. BytesToReadThe 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.

Применяется к