Reference.StreamPeek History

Hide minor edits - Show changes to output

November 02, 2011, at 05:05 PM by Scott Fitzgerald -
Deleted line 1:
Deleted line 23:
* [[StreamWrite | write()]]
November 02, 2011, at 05:04 PM by Scott Fitzgerald -
Added lines 1-25:


!!peek()

Read a byte from the file without advancing to the next one. That is, successive calls to peek() will return the same value, as will the next call to read().

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

!!!!Syntax

''stream''.peek()

!!!!Parameters

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

!!!!Returns

The next byte (or character), or -1 if none is available.

!!!!See Also

* [[StreamAvailable | available()]]
* [[StreamRead | read()]]
* [[StreamWrite | write()]]

Share