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.
Namespace: System.IO
Assembly: mscorlib (in mscorlib.dll)
Return Value
Type: System.Int32An integer representing the next character to be read, or -1 if no more characters are available or the reader does not support seeking.
| Exception | Condition |
|---|---|
| ObjectDisposedException | The TextReader is closed. |
| IOException | An I/O error occurs. |
The 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 TextReader is not changed by this operation. The returned value is -1 if no more characters are available. The default implementation returns -1.
The TextReader class is an abstract class. Therefore, you do instantiate it in your code. For an example of using the Peek method, see the StreamReader.Peek method.
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.