TextReader.Peek メソッド

.NET Framework クラス ライブラリ リファレンス

TextReader.Peek メソッド

リーダーや文字の読み取り元の状態を変更せずに、次の文字を読み取ります。入力ストリームから実際に文字を読み取らずに次の文字を返します。

名前空間: System.IO
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Overridable Function
 Peek As Integer

Visual Basic (使用法)

Dim instance As TextReader
Dim returnValue As Integer

returnValue = instance.Peek

C#

public virtual int Peek ()

C++

public:
virtual int Peek ()

J#

public int Peek ()

JScript

public function Peek () : int

戻り値
読み取り対象の次の文字を表す整数。使用できる文字がないか、ストリームがシークをサポートしていない場合は -1。

例外

例外の種類	条件
ObjectDisposedException	TextReader が閉じています。
IOException	I/O エラーが発生しました。

解説

Peek メソッドは、ファイルの末尾に達したのか、または別のエラーが発生したのかを判断するために、整数値を返します。これにより、ユーザーは戻り値が -1 かどうかをチェックしてから Char 型にキャストできます。

TextReader の現在位置が、この操作によって変更されることはありません。使用できる文字がない場合、戻り値は -1 になります。既定の実装では、-1 が返されます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
TextReader クラス
TextReader メンバ
System.IO 名前空間
その他の技術情報
ファイルおよびストリーム入出力
方法 : ファイルからテキストを読み取る
方法 : ファイルにテキストを書き込む