Stream.readBytes()

Description

readBytes() read characters from a stream into a buffer. The function terminates if the determined length has been read, or it times out (see setTimeout()).

readBytes() returns the number of bytes placed in the buffer. A 0 means no valid data was found.

This function is part of the Stream class, and can be called by any class that inherits from it (Wire, Serial, etc). See the Stream class main page for more information.

Syntax

stream.readBytes(buffer, length)

Parameter Values

• stream: an instance of a class that inherits from Stream.
• buffer: the buffer to store the bytes in. Allowed data types: array of char or byte.
• length: the number of bytes to read. Allowed data types: int.

Return Values

• The number of bytes placed in the buffer. Data type: size_t.

See Also

• Language : Arduino - Stream
• Language : Stream.available()
• Language : Stream.find()
• Language : Stream.findUntil()
• Language : Stream.flush()
• Language : Stream.getTimeout()
• Language : Stream.parseFloat()
• Language : Stream.parseInt()
• Language : Stream.peek()
• Language : Stream.read()
• Language : Stream.readBytesUntil()
• Language : Stream.readString()
• Language : Stream.readStringUntil()
• Language : Stream.setTimeout()