UnmanagedMemoryStream クラス

定義

名前空間:

System.IO

アセンブリ:

System.Runtime.dll

ソース:

UnmanagedMemoryStream.cs

重要

この API は CLS 準拠ではありません。

マネージド コードからアンマネージ メモリ ブロックへのアクセスを提供します。

public ref class UnmanagedMemoryStream : System::IO::Stream

public class UnmanagedMemoryStream : System.IO.Stream

type UnmanagedMemoryStream = class
    inherit Stream

Public Class UnmanagedMemoryStream
Inherits Stream

継承

Object

MarshalByRefObject

Stream

UnmanagedMemoryStream

派生

System.IO.MemoryMappedFiles.MemoryMappedViewStream

例

次のコード例では、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();
    }
}

注釈

このクラスは、既存のストリーム ベースのモデルを使用してアンマネージ メモリへのアクセスをサポートしており、アンマネージ メモリ内の内容をヒープにコピーする必要はありません。

手記

この型は IDisposable インターフェイスを実装しますが、実際には破棄するリソースはありません。 つまり、Dispose() を直接呼び出すか、using (C#) や Using (Visual Basic) などの言語コンストラクトを使用して破棄する必要はありません。

コンストラクター

UnmanagedMemoryStream()	UnmanagedMemoryStream クラスの新しいインスタンスを初期化します。
UnmanagedMemoryStream(Byte*, Int64)	指定した場所とメモリの長さを使用して、UnmanagedMemoryStream クラスの新しいインスタンスを初期化します。
UnmanagedMemoryStream(Byte*, Int64, Int64, FileAccess)	指定した場所、メモリの長さ、メモリの総量、ファイル アクセスの値を使用して、UnmanagedMemoryStream クラスの新しいインスタンスを初期化します。
UnmanagedMemoryStream(SafeBuffer, Int64, Int64)	指定したオフセットと長さを使用して、セーフ バッファー内の UnmanagedMemoryStream クラスの新しいインスタンスを初期化します。
UnmanagedMemoryStream(SafeBuffer, Int64, Int64, FileAccess)	指定したオフセット、長さ、およびファイル アクセスを使用して、安全なバッファー内の UnmanagedMemoryStream クラスの新しいインスタンスを初期化します。

プロパティ

CanRead	ストリームが読み取りをサポートしているかどうかを示す値を取得します。
CanSeek	ストリームがシークをサポートしているかどうかを示す値を取得します。
CanTimeout	現在のストリームがタイムアウトできるかどうかを決定する値を取得します。 (継承元 Stream)
CanWrite	ストリームが書き込みをサポートしているかどうかを示す値を取得します。
Capacity	ストリームの長さ (サイズ) またはストリームに割り当てられたメモリの合計量 (容量) を取得します。
Length	ストリーム内のデータの長さを取得します。
Position	ストリーム内の現在位置を取得または設定します。
PositionPointer	ストリーム内の現在位置に基づいてストリームへのバイト ポインターを取得または設定します。
ReadTimeout	ストリームがタイムアウトするまでの読み取りを試行する時間を決定する値をミリ秒単位で取得または設定します。 (継承元 Stream)
WriteTimeout	ストリームがタイムアウトするまでの書き込みを試行する時間を決定する値をミリ秒単位で取得または設定します。 (継承元 Stream)

メソッド

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	非同期読み取り操作を開始します。 (代わりに ReadAsync(Byte[], Int32, Int32) を使用することを検討してください)。 (継承元 Stream)
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	非同期書き込み操作を開始します。 (代わりに WriteAsync(Byte[], Int32, Int32) を使用することを検討してください)。 (継承元 Stream)
Close()	現在のストリームを閉じ、現在のストリームに関連付けられているリソース (ソケットやファイル ハンドルなど) を解放します。 このメソッドを呼び出す代わりに、ストリームが適切に破棄されていることを確認します。 (継承元 Stream)
CopyTo(Stream)	現在のストリームからバイトを読み取り、別のストリームに書き込みます。 どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CopyTo(Stream, Int32)	現在のストリームからバイトを読み取り、指定されたバッファー サイズを使用して別のストリームに書き込みます。 どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CopyToAsync(Stream)	現在のストリームからバイトを非同期に読み取り、別のストリームに書き込みます。 どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CopyToAsync(Stream, CancellationToken)	現在のストリームからバイトを非同期に読み取り、指定されたキャンセル トークンを使用して別のストリームに書き込みます。 どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CopyToAsync(Stream, Int32)	現在のストリームからバイトを非同期に読み取り、指定されたバッファー サイズを使用して別のストリームに書き込みます。 どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CopyToAsync(Stream, Int32, CancellationToken)	指定したバッファー サイズとキャンセル トークンを使用して、現在のストリームからバイトを非同期に読み取り、別のストリームに書き込みます。 どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CreateObjRef(Type)	リモート オブジェクトとの通信に使用されるプロキシの生成に必要なすべての関連情報を含むオブジェクトを作成します。 (継承元 MarshalByRefObject)
CreateWaitHandle()	古い. WaitHandle オブジェクトを割り当てます。 (継承元 Stream)
Dispose()	Streamで使用されているすべてのリソースを解放します。 (継承元 Stream)
Dispose(Boolean)	UnmanagedMemoryStream によって使用されるアンマネージ リソースを解放し、必要に応じてマネージド リソースを解放します。
DisposeAsync()	Streamによって使用されるアンマネージ リソースを非同期的に解放します。 (継承元 Stream)
EndRead(IAsyncResult)	保留中の非同期読み取りが完了するまで待機します。 (代わりに ReadAsync(Byte[], Int32, Int32) を使用することを検討してください)。 (継承元 Stream)
EndWrite(IAsyncResult)	非同期書き込み操作を終了します。 (代わりに WriteAsync(Byte[], Int32, Int32) を使用することを検討してください)。 (継承元 Stream)
Equals(Object)	指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
Flush()	アクションが実行されないように、Flush() メソッドをオーバーライドします。
FlushAsync()	このストリームのすべてのバッファーを非同期的にクリアし、バッファー内のデータを基になるデバイスに書き込みます。 (継承元 Stream)
FlushAsync(CancellationToken)	FlushAsync(CancellationToken) メソッドをオーバーライドして、指定した場合に操作が取り消されるようにしますが、他のアクションは実行されません。
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetLifetimeService()	古い. このインスタンスの有効期間ポリシーを制御する現在の有効期間サービス オブジェクトを取得します。 (継承元 MarshalByRefObject)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
Initialize(Byte*, Int64, Int64, FileAccess)	アンマネージ メモリの場所へのポインターを使用して、UnmanagedMemoryStream クラスの新しいインスタンスを初期化します。
Initialize(SafeBuffer, Int64, Int64, FileAccess)	指定したオフセット、長さ、およびファイル アクセスを使用して、安全なバッファー内の UnmanagedMemoryStream クラスの新しいインスタンスを初期化します。
InitializeLifetimeService()	古い. このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。 (継承元 MarshalByRefObject)
MemberwiseClone()	現在の Objectの簡易コピーを作成します。 (継承元 Object)
MemberwiseClone(Boolean)	現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。 (継承元 MarshalByRefObject)
ObjectInvariant()	古い. Contractのサポートを提供します。 (継承元 Stream)
Read(Byte[], Int32, Int32)	指定したバイト数を、指定した配列に読み取ります。
Read(Span<Byte>)	このアンマネージ メモリ ストリームのすべてのバイトを、指定されたバイトスパンに読み取ります。
ReadAsync(Byte[], Int32, Int32)	現在のストリームからバイト シーケンスを非同期に読み取り、ストリーム内の位置を読み取ったバイト数だけ進めます。 (継承元 Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	指定したバイト数を、指定した配列に非同期的に読み取ります。
ReadAsync(Memory<Byte>, CancellationToken)	アンマネージ メモリ ストリームのバイトをメモリ領域に非同期的に読み取ります。
ReadAtLeast(Span<Byte>, Int32, Boolean)	現在のストリームから少なくともバイト数を読み取り、読み取ったバイト数だけストリーム内の位置を進めます。 (継承元 Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	現在のストリームから少なくとも最小バイト数を非同期に読み取り、読み取ったバイト数だけストリーム内の位置を進め、キャンセル要求を監視します。 (継承元 Stream)
ReadByte()	ストリームからバイトを読み取り、ストリーム内の位置を 1 バイト進めるか、ストリームの末尾にある場合は -1 を返します。
ReadExactly(Byte[], Int32, Int32)	現在のストリーム count バイト数を読み取り、ストリーム内の位置を進めます。 (継承元 Stream)
ReadExactly(Span<Byte>)	現在のストリームからバイトを読み取り、buffer がいっぱいになるまでストリーム内の位置を進めます。 (継承元 Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	現在のストリーム count バイト数を非同期に読み取り、ストリーム内の位置を進め、キャンセル要求を監視します。 (継承元 Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	現在のストリームからバイトを非同期に読み取り、buffer がいっぱいになるまでストリーム内の位置を進め、取り消し要求を監視します。 (継承元 Stream)
Seek(Int64, SeekOrigin)	現在のストリームの現在位置を指定された値に設定します。
SetLength(Int64)	ストリームの長さを指定した値に設定します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)
Write(Byte[], Int32, Int32)	バッファーからのデータを使用して、現在のストリームにバイト ブロックを書き込みます。
Write(ReadOnlySpan<Byte>)	指定されたバイトスパンのデータを使用して、現在のアンマネージ メモリ ストリームにバイト ブロックを書き込みます。
WriteAsync(Byte[], Int32, Int32)	現在のストリームにバイト シーケンスを非同期に書き込み、書き込まれたバイト数だけこのストリーム内の現在位置を進めます。 (継承元 Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	現在のストリームにバイトシーケンスを非同期に書き込み、書き込まれたバイト数だけこのストリーム内の現在位置を進め、キャンセル要求を監視します。
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	現在のストリームにバイトスパンを非同期に書き込み、書き込まれたバイト数だけこのストリーム内の現在位置を進め、キャンセル要求を監視します。
WriteByte(Byte)	ファイル ストリーム内の現在位置にバイトを書き込みます。

拡張メソッド

CopyToAsync(Stream, PipeWriter, CancellationToken)	キャンセル トークンを使用して、Stream からバイトを非同期に読み取り、指定した PipeWriterに書き込みます。
ConfigureAwait(IAsyncDisposable, Boolean)	非同期破棄から返されるタスクの待機を実行する方法を構成します。