Read Method

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Reads a number of bytes from the SerialPort input buffer and writes those bytes into a byte array at the specified offset.

Namespace:  System.IO.Ports
Assembly:  Microsoft.SPOT.Hardware.SerialPort (in Microsoft.SPOT.Hardware.SerialPort.dll)

public override int Read(
	byte[] buffer,
	int offset,
	int count
)

Parameters

buffer
Type: array<System..::..Byte>[]()[][]
The byte array to write the input to.
offset
Type: System..::..Int32
The offset in the buffer array to begin writing.
count
Type: System..::..Int32
The number of bytes to read.

Return Value

Type: System..::..Int32
The number of bytes read.

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.

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 Read method does not block other operations when the number of bytes read equals count but there are still unread bytes available on the serial port.

Show: