MemoryStream.Read メソッド

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

MemoryStream.Read メソッド

現在のストリームからバイトのブロックを読み取り、データを buffer に書き込みます。

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

Visual Basic (宣言)

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

Visual Basic (使用法)

Dim instance As MemoryStream
Dim buffer As Byte()
Dim offset As Integer
Dim count As Integer
Dim returnValue As Integer

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

C#

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

C++

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

J#

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

JScript

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

パラメータ

buffer

このメソッドが戻るとき、指定したバイト配列の offset から (offset + count - 1) までの値が、現在のストリームから読み取られた文字に置き換えられています。

offset

読み取りの開始位置を示す buffer 内のバイト オフセット。

count

読み取る最大バイト数。

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

例外

例外の種類	条件
ArgumentNullException	buffer が null 参照 (Visual Basic では Nothing) です。
ArgumentOutOfRangeException	offset または count が負の値です。
ArgumentException	バッファ長から offset を差し引いた値が count より小さい値です。
ObjectDisposedException	現在のストリーム インスタンスが閉じています。

解説

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

このメソッドは、Read をオーバーライドします。

offset パラメータは、現在のストリームから書き込まれるデータに buffer の先頭バイトからのオフセットを指定します。count パラメータは、現在のストリームから読み込む最大バイト数を指定します。戻り値は、実際に読み取ったバイト数であり、ストリームの末尾に到達している場合は 0 です。

読み取り操作が正常に終了した場合、ストリームの現在位置は読み取ったバイト数だけ進みます。例外が発生した場合、ストリームの現在位置は変更されません。

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

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

注意
buffer パラメータで指定したバイト配列が、GetBuffer メソッドで返される基になるバッファの場合、配列の内容は上書きされ、例外はスローされません。

使用例

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

Visual Basic

' Read the first 20 bytes from the stream.
byteArray = _
    New Byte(CType(memStream.Length, Integer)){}
count = memStream.Read(byteArray, 0, 20)

C#

// Read the first 20 bytes from the stream.
byteArray = new byte[memStream.Length];
count = memStream.Read(byteArray, 0, 20);

C++

// Read the first 20 bytes from the stream.
byteArray = gcnew array<Byte>(memStream->Length);
count = memStream->Read( byteArray, 0, 20 );

J#

// Read the first 20 bytes from the stream.
byteArray = new ubyte[(int)memStream.get_Length()];
count = memStream.Read(byteArray, 0, 20);

プラットフォーム

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

参照

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