Share via


Peek Method

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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:  System.IO (in System.IO.dll)

Syntax

'Declaration
Public Overridable Function Peek As Integer
public virtual int Peek()
public:
virtual int Peek()
abstract Peek : unit -> int 
override Peek : unit -> int 
public function Peek() : int

Return Value

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

Remarks

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.

.NET Framework Security

See Also

Reference

TextReader Class

System.IO Namespace