SerialPort.ReadExisting Метод

Определение

Считывает все непосредственно доступные байты в соответствии с кодировкой из потока и из входного буфера объекта SerialPort.Reads all immediately available bytes, based on the encoding, in both the stream and the input buffer of the SerialPort object.

public:
 System::String ^ ReadExisting();
public string ReadExisting ();
member this.ReadExisting : unit -> string
Public Function ReadExisting () As String

Возвраты

Содержимое потока и входного буфера объекта SerialPort.The contents of the stream and the input buffer of the SerialPort object.

Исключения

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

Комментарии

Этот метод возвращает содержимое потока и внутренний буфер SerialPort объекта в виде строки.This method returns the contents of the stream and internal buffer of the SerialPort object as a string. Этот метод не использует время ожидания. Обратите внимание, что этот метод может оставить конечные старшие байты во внутреннем BytesToRead буфере, что делает значение больше нуля.This method does not use a time-out. Note that this method can leave trailing lead bytes in the internal buffer, which makes the BytesToRead value greater than zero.

Если необходимо переключаться между чтением текста и считыванием двоичных данных из потока, выберите протокол, который аккуратно определяет границу между текстовыми и двоичными данными, например чтение вручную байтов и декодирование данных.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.

Примечание

Класс помещает данные в буфер, но объект потока, содержащийся SerialPort.BaseStream в свойстве, — нет. SerialPortThe SerialPort class buffers data, but the stream object contained in the SerialPort.BaseStream property does not. Таким образом, SerialPort объект и объект потока могут отличаться от числа байтов, доступных для чтения.Therefore, the SerialPort object and the stream object might differ on the number of bytes that are available to read. Если байты буферизованы SerialPort в объект BytesToRead , свойство включает эти байты в свое значение, однако эти байты могут быть недоступны для потока BaseStream , содержащегося в свойстве.When bytes are buffered to the SerialPort object, the BytesToRead property includes these bytes in its value; however, these bytes might not be accessible to the stream contained in the BaseStream property.

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