Arduino Programming Language: Stream.readBytesUntil

Name

readBytesUntil()

Description

Reads characters from a stream into a buffer. The function terminates if the terminator character is detected, the determined length has been read, or it times out (see setTimeout()). 
readBytesUntil() returns the number of bytes placed in the buffer. A 0 means no valid data was found.

Syntax

stream.readBytesUntil(character, buffer, length)

Parameters

  • stream : an instance of a class that inherits from Stream.
  • character : the character to search for (char)
  • buffer: the buffer to store the bytes in (char[] or byte[])
  • length : the number of bytes to read (int)

Returns

 int: the number of bytes placed in the buffer


Based on the reference originally written by Arduino Community,  wiring.org.co and  arduino.cc