IsolatedStorageFileStream.Read メソッド

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

IsolatedStorageFileStream.Read メソッド

現在のバッファ内の IsolatedStorageFileStream オブジェクトから配列にバイトをコピーします。

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

Visual Basic (宣言)

Public Overrides Function
 Read ( _
    buffer As Byte(), _
    offset As Integer, _
    count As Integer _
) As Integer

Visual Basic (使用法)

Dim instance As IsolatedStorageFileStream
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 (
    byte[] buffer,
    int offset,
    int count
)

C++

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

J#

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

JScript

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

パラメータ

buffer

読み取るバッファ。

offset

書き込みの開始位置を示すバッファ内のオフセット。

count

読み取る最大バイト数。

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

解説

buffer パラメータには、Buffer クラスのインスタンス、または Byte、SByte、Char、Int16、Int32、Int64、UInt16、UInt32、UInt64、Single、Double のいずれかの型の配列を指定できます。offset パラメータは書き込みを開始する位置のバッファ内のバイトのオフセット (バッファ インデックス) を指定し、count パラメータはこのストリームから読み取るバイトの最大数を指定します。戻り値は、実際に読み取ったバイト数であり、ストリームの末尾に到達している場合は 0 です。読み取り操作が正常に終了した場合、ストリームの現在位置は読み取ったバイト数だけ進みます。例外が発生した場合、ストリームの現在位置は変更されません。

Read メソッドは、実際の型にかかわらず、buffer パラメータをバイトのブロックとして処理します。同様に、offset パラメータと count パラメータは、必ずバイトで指定します。バイト配列以外の buffer パラメータでは、offset に対する正確な値または count を算出するために、要素インデックスにバイト単位の要素サイズを掛け合わせる必要があります。

Read メソッドは、ストリームの末尾に到達した場合にだけ 0 を返します。それ以外の場合、Read は常に戻り値を返す前にストリームから少なくとも 1 バイトを読み取ります。Read の呼び出し時に利用できるデータが IsolatedStorageFileStream オブジェクトにない場合、このメソッドは少なくとも 1 バイトのデータを返すまでブロックします。

プラットフォーム

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

参照

関連項目
IsolatedStorageFileStream クラス
IsolatedStorageFileStream メンバ
System.IO.IsolatedStorage 名前空間