Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1015 Bytes

streamReadStringUntil.adoc

File metadata and controls

53 lines (33 loc) · 1015 Bytes
title
Stream.readStringUntil()

readStringUntil()

Description

readStringUntil() reads characters from a stream into a String. The function terminates if the terminator character is detected or it times out (see setTimeout()).

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

Syntax

stream.readString(terminator)

Parameters

stream : an instance of a class that inherits from Stream.

terminator : the character to search for (char)

Returns

The entire String read from a stream, up to the terminator character

Notes and Warnings

The terminator character is discarded from the stream.