BufferedStream.Read メソッド

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

BufferedStream.Read メソッド

現在のバッファ ストリームから配列にバイトをコピーします。

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

Visual Basic (宣言)

Public Overrides Function
 Read ( _
    <InAttribute> <OutAttribute> array As Byte(),
 _
    offset As Integer, _
    count As Integer _
) As Integer

Visual Basic (使用法)

Dim instance As BufferedStream
Dim array As Byte()
Dim offset As Integer
Dim count As Integer
Dim returnValue As Integer

returnValue = instance.Read(array, offset, count)

C#

public override int Read (
    [InAttribute] [OutAttribute] byte[] array,
    int offset,
    int count
)

C++

public:
virtual int Read (
    [InAttribute] [OutAttribute] array<unsigned char>^ array,
 
    int offset, 
    int count
) override

J#

public int Read (
    /** @attribute InAttribute() */ /** @attribute OutAttribute() */ byte[] array,
 
    int offset, 
    int count
)

JScript

public override function Read (
    array : byte[], 
    offset : int, 
    count : int
) : int

パラメータ

array

バイトをコピーするバッファ。

offset

バイトの読み取りを開始するバッファのバイト オフセット。

count

読み取るバイト数。

戻り値
array に読み込む合計バイト数。要求しただけのバイト数を読み込むことができなかった場合、この値は要求したバイト数より小さくなります。データを読み取る前にストリームの末尾に到達した場合は 0 になります。

例外

例外の種類	条件
ArgumentException	array 長から offset を引いた値が count 未満です。
ArgumentNullException	array が null 参照 (Visual Basic では Nothing) です。
ArgumentOutOfRangeException	offset または count が負の値です。
IOException	ストリームが開いていないか、null 参照 (Visual Basic では Nothing) になっています。
NotSupportedException	ストリームが読み取りをサポートしていません。
ObjectDisposedException	ストリームが閉じられた後でメソッドが呼び出されました。

解説

ファイルの作成およびテキストのファイルへの書き込みの例については、「方法 : ファイルにテキストを書き込む」を参照してください。ファイルからのテキストの読み取りの例については、「方法 : ファイルからテキストを読み取る」を参照してください。バイナリ ファイルの読み取りおよび書き込みの例については、「方法 : 新しく作成されたデータ ファイルに対して読み書きする」を参照してください。

Read メソッドは、ストリームの末尾に到達した場合にだけ 0 を返します。それ以外の場合、Read は常に戻り値を返す前にストリームから少なくとも 1 バイトを読み取ります。定義上は、Read の呼び出し時にストリームにデータがない場合、Read メソッドは 0 を返し、自動的にストリームの末尾に到達します。メソッドの実装は、ストリームの末尾に到達していない場合でも、要求された数に満たないバイトを返すようにすることができます。

プリミティブ データ型を読み取る場合は BinaryReader を使用します。

使用例

このコード例は、BufferedStream クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

' Receive data using the BufferedStream.
Console.WriteLine("Receiving data using BufferedStream.")
bytesReceived = 0
startTime = DateTime.Now
While bytesReceived < numberOfLoops * receivedData.Length
    bytesReceived += bufStream.Read( _
        receivedData, 0, receivedData.Length)
End While
bufferedTime = DateTime.Now.Subtract(startTime).TotalSeconds
Console.WriteLine("{0} bytes received in {1} " &
 _
    "seconds." & vbCrLf, _
    bytesReceived.ToString(), _
    bufferedTime.ToString("F1"))

C#

// Receive data using the BufferedStream.
Console.WriteLine("Receiving data using BufferedStream.");
bytesReceived = 0;
startTime = DateTime.Now;
while(bytesReceived < numberOfLoops * receivedData.Length)
{
    bytesReceived += bufStream.Read(
        receivedData, 0, receivedData.Length);
}
bufferedTime = (DateTime.Now - startTime).TotalSeconds;
Console.WriteLine("{0} bytes received in {1} seconds.\n"
,
    bytesReceived.ToString(), 
    bufferedTime.ToString("F1"));

C++

// Receive data using the BufferedStream.
Console::WriteLine(  "Receiving data using BufferedStream."
 );
bytesReceived = 0;
startTime = DateTime::Now;
while ( bytesReceived < numberOfLoops * receivedData->Length
 )
{
   bytesReceived += bufStream->Read( receivedData, 0, receivedData->Length
 );
}

bufferedTime = (DateTime::Now - startTime).TotalSeconds;
Console::WriteLine( "{0} bytes received in {1} seconds.\n",
 bytesReceived.ToString(), bufferedTime.ToString(  "F1" ) );

J#

// Receive data using the BufferedStream.
Console.WriteLine("Receiving data using BufferedStream.");
bytesReceived = 0;
startTime = DateTime.get_Now();
while((bytesReceived < numberOfLoops * receivedData.length))
 {
    bytesReceived += bufStream.Read(receivedData,0,receivedData.length);
}
bufferedTime =
    ((DateTime.get_Now()).Subtract(startTime)).get_TotalSeconds();
Console.WriteLine("{0} bytes received in {1} seconds.\n"
,
    (new Integer(bytesReceived)).ToString(),
    ((System.Double) bufferedTime).ToString("F1"));

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

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