System.IO.TextReader.Peek Method

Reads the next character without changing the state of the reader or the character source. Returns the next available character without actually reading it from the reader.

Syntax

public virtual int Peek ()

Returns

An integer representing the next character to be read, or -1 if no more characters are available or the reader does not support seeking.

Exceptions

TypeReason
System.IO.IOExceptionAn I/O error has occurred.

Remarks

The TextReader.Peek method returns an integer value in order to determine whether the end of the file, or another error has occurred. This allows a user to first check if the returned value is -1 before casting it to a char type.

The current position of the System.IO.TextReader is not changed by this operation. The returned value is -1 if no more characters are available. The default implementation returns -1.

The System.IO.TextReader class is an abstract class. Therefore, you do not instantiate it in your code. For an example of using the TextReader.Peek method, see the StreamReader.Peek method.

Requirements

Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 1.0.5000.0, 2.0.0.0, 4.0.0.0