Share via


Peek Method

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

Returns the next available character but does not consume it.

Namespace:  System.IO
Assembly:  System.IO (in System.IO.dll)

Syntax

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

Return Value

Type: System. . :: . .Int32
An integer representing the next character to be read, or -1 if there are no characters to be read or if the stream 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 StreamReader object is not changed by Peek.

.NET Framework Security

See Also

Reference

StreamReader Class

System.IO Namespace