StringReader.Peek Method

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Returns the next available character but does not consume it.

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

Syntax

'Declaration
Public Overrides Function Peek As Integer
public override int Peek()

Return Value

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

Exceptions

Exception Condition
ObjectDisposedException

The current reader is closed.

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.

This method overrides the TextReader.Peek method.

The current position of the StringReader is not changed by this operation.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.