UnmanagedMemoryStream.Read メソッド

定義

名前空間:

System.IO

アセンブリ:

System.Runtime.dll

オーバーロード

Read(Span<Byte>)	このアンマネージ メモリ ストリームのすべてのバイトを、指定したバイトの範囲に読み取ります。
Read(Byte[], Int32, Int32)	指定したバイト数を指定した配列に読み取ります。

Read(Span<Byte>)

ソース:

UnmanagedMemoryStream.cs

このアンマネージ メモリ ストリームのすべてのバイトを、指定したバイトの範囲に読み取ります。

public:
 override int Read(Span<System::Byte> buffer);

public override int Read (Span<byte> buffer);

override this.Read : Span<byte> -> int

Public Overrides Function Read (buffer As Span(Of Byte)) As Integer

パラメーター

buffer

Span<Byte>

このメソッドから制御が戻るときに、この範囲にはアンマネージ メモリ ストリームのすべてのバイトが含まれます。

戻り値

Int32

同期先に読み取られた合計バイト数。

Read(Byte[], Int32, Int32)

ソース:

UnmanagedMemoryStream.cs

指定したバイト数を指定した配列に読み取ります。

public:
 override int Read(cli::array <System::Byte> ^ buffer, int offset, int count);

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

override this.Read : byte[] * int * int -> int

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

パラメーター

buffer

Byte[]

このメソッドが返されるときに、指定したバイト配列の offset から (offset + count - 1) までの値が、現在のソースから読み取られたバイトに置き換えられます。 このパラメーターは初期化せずに渡されます。

offset

Int32

現在のストリームから読み取ったデータの格納を開始する位置を示す buffer 内のバイト オフセット。インデックス番号は 0 から始まります。

count

Int32

現在のストリームから読み取る最大バイト数。

戻り値

Int32

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

例外

ObjectDisposedException

ストリームは閉じられています。

NotSupportedException

基になるメモリが読み取りをサポートしていません。

または

CanRead プロパティが false に設定されている。

ArgumentNullException

buffer パラメーターを null に設定します。

ArgumentOutOfRangeException

offset パラメーターが 0 未満。

または

count パラメーターが 0 未満。

ArgumentException

バッファー配列の長さから offset パラメーターを引いた値が、count パラメーター未満です。

例

次のコード例では、 クラスを使用してアンマネージド メモリの読み取りと書き込みを行う方法を UnmanagedMemoryStream 示します。 アンマネージ メモリのブロックは、 クラスを使用して Marshal 割り当てられ、割り当て解除されます。

// Note: you must compile this sample using the unsafe flag.
// From the command line, type the following: csc sample.cs /unsafe

using System;
using System.IO;
using System.Text;
using System.Runtime.InteropServices;

unsafe class TestWriter
{
    static void Main()
    {
        // Create some data to read and write.
        byte[] message = UnicodeEncoding.Unicode.GetBytes("Here is some data.");

        // Allocate a block of unmanaged memory and return an IntPtr object.	
        IntPtr memIntPtr = Marshal.AllocHGlobal(message.Length);

        // Get a byte pointer from the IntPtr object.
        byte* memBytePtr = (byte*)memIntPtr.ToPointer();

        // Create an UnmanagedMemoryStream object using a pointer to unmanaged memory.
        UnmanagedMemoryStream writeStream = new UnmanagedMemoryStream(memBytePtr, message.Length, message.Length, FileAccess.Write);

        // Write the data.
        writeStream.Write(message, 0, message.Length);

        // Close the stream.
        writeStream.Close();

        // Create another UnmanagedMemoryStream object using a pointer to unmanaged memory.
        UnmanagedMemoryStream readStream = new UnmanagedMemoryStream(memBytePtr, message.Length, message.Length, FileAccess.Read);

        // Create a byte array to hold data from unmanaged memory.
        byte[] outMessage = new byte[message.Length];

        // Read from unmanaged memory to the byte array.
        readStream.Read(outMessage, 0, message.Length);

        // Close the stream.
        readStream.Close();

        // Display the data to the console.
        Console.WriteLine(UnicodeEncoding.Unicode.GetString(outMessage));

        // Free the block of unmanaged memory.
        Marshal.FreeHGlobal(memIntPtr);

        Console.ReadLine();
    }
}

注釈

パラメーターは offset 、読み取りを開始するパラメーター (バッファー インデックス) 内 array のバイトのオフセットを指定し count 、 パラメーターは、このストリームから読み取る最大バイト数を指定します。 返される値は、読み取られた実際のバイト数です。ストリームの末尾に達した場合は 0 です。 読み取り操作が成功した場合、ストリームの現在位置は読み取られたバイト数だけ進みます。 例外が発生した場合、ストリームの現在位置は変更されません。

メソッドは Read 、ストリームの末尾に到達した後にのみ 0 を返します。 それ以外の場合は、 Read 常にストリームから少なくとも 1 バイトを読み取ってからを返します。 への Read呼び出し時にストリームから使用できるデータがない場合、 メソッドは、少なくとも 1 バイトのデータが返されるまでブロックします。 実装では、ストリームの末尾に達していない場合でも、要求されたバイト数よりも少ないバイト数を自由に返します。