Stream クラス

定義

public ref class Stream abstract : IDisposable

public ref class Stream abstract : MarshalByRefObject, IAsyncDisposable, IDisposable

public ref class Stream abstract : MarshalByRefObject, IDisposable

public abstract class Stream : IDisposable

public abstract class Stream : MarshalByRefObject, IAsyncDisposable, IDisposable

public abstract class Stream : MarshalByRefObject, IDisposable

[System.Serializable]
public abstract class Stream : MarshalByRefObject, IDisposable

[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class Stream : MarshalByRefObject, IDisposable

type Stream = class
    interface IDisposable

type Stream = class
    inherit MarshalByRefObject
    interface IAsyncDisposable
    interface IDisposable

type Stream = class
    inherit MarshalByRefObject
    interface IDisposable

[<System.Serializable>]
type Stream = class
    inherit MarshalByRefObject
    interface IDisposable

[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type Stream = class
    inherit MarshalByRefObject
    interface IDisposable

Public MustInherit Class Stream
Implements IDisposable

Public MustInherit Class Stream
Inherits MarshalByRefObject
Implements IAsyncDisposable, IDisposable

Public MustInherit Class Stream
Inherits MarshalByRefObject
Implements IDisposable

継承

Object

Stream

継承

Object

MarshalByRefObject

Stream

派生

Microsoft.JScript.COMCharStream

System.Data.OracleClient.OracleBFile

System.Data.OracleClient.OracleLob

System.Data.SqlTypes.SqlFileStream

System.IO.BufferedStream

その他…

属性

SerializableAttribute ComVisibleAttribute

実装

IDisposable IAsyncDisposable

例

次の例では、2 つの FileStream オブジェクトを使用して、1 つのディレクトリから別のディレクトリにファイルを非同期的にコピーする方法を示します。 FileStream クラスは、Stream クラスから派生します。 Button コントロールの Click イベント ハンドラーは、非同期メソッドを呼び出すので、async 修飾子でマークされていることに注意してください。

using System;
using System.Threading.Tasks;
using System.Windows;
using System.IO;

namespace WpfApplication
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string StartDirectory = @"c:\Users\exampleuser\start";
            string EndDirectory = @"c:\Users\exampleuser\end";

            foreach (string filename in Directory.EnumerateFiles(StartDirectory))
            {
                using (FileStream SourceStream = File.Open(filename, FileMode.Open))
                {
                    using (FileStream DestinationStream = File.Create(EndDirectory + filename.Substring(filename.LastIndexOf('\\'))))
                    {
                        await SourceStream.CopyToAsync(DestinationStream);
                    }
                }
            }
        }
    }
}

Imports System.IO

Class MainWindow

    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim StartDirectory As String = "c:\Users\exampleuser\start"
        Dim EndDirectory As String = "c:\Users\exampleuser\end"

        For Each filename As String In Directory.EnumerateFiles(StartDirectory)
            Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
                Using DestinationStream As FileStream = File.Create(EndDirectory + filename.Substring(filename.LastIndexOf("\"c)))
                    Await SourceStream.CopyToAsync(DestinationStream)
                End Using

            End Using
        Next
    End Sub

End Class

注釈

Stream は、すべてのストリームの抽象基底クラスです。 ストリームは、ファイル、入出力デバイス、プロセス間通信パイプ、TCP/IP ソケットなどのバイト シーケンスの抽象化です。 Stream クラスとその派生クラスは、これらのさまざまな種類の入力と出力の汎用ビューを提供し、オペレーティング システムと基になるデバイスの特定の詳細からプログラマを分離します。

ストリームには、次の 3 つの基本的な操作が含まれます。

• ストリームから読み取ることができます。 読み取りは、ストリームからデータ構造 (バイト配列など) へのデータの転送です。

• ストリームに書き込むことができます。 書き込みは、データ構造からストリームへのデータの転送です。

• ストリームはシークをサポートできます。 シークとは、ストリーム内の現在位置のクエリと変更を指します。 シーク機能は、ストリームに含まれるバッキング ストアの種類によって異なります。 たとえば、ネットワーク ストリームには現在位置の統一された概念がないため、通常はシークをサポートしていません。

Stream から継承する一般的に使用されるストリームの一部は、FileStream、および MemoryStreamです。

基になるデータ ソースまたはリポジトリによっては、これらの機能の一部のみがストリームでサポートされる場合があります。 Stream クラスの CanRead、CanWrite、および CanSeek プロパティを使用して、ストリームの機能を照会できます。

Read メソッドと Write メソッドは、さまざまな形式でデータの読み取りと書き込みを行います。 シークをサポートするストリームの場合は、Seek メソッドと SetLength メソッド、および Position プロパティと Length プロパティを使用して、ストリームの現在の位置と長さを照会および変更します。

この型は、IDisposable インターフェイスを実装します。 型の使用が完了したら、直接または間接的に破棄する必要があります。 型を直接破棄するには、try/catch ブロックでその Dispose メソッドを呼び出します。 間接的に破棄するには、using (C#) や Using (Visual Basic) などの言語コンストラクトを使用します。 詳細については、「IDisposable インターフェイス」トピックの「IDisposable を実装するオブジェクトの使用」セクションを参照してください。

Stream オブジェクトを破棄すると、バッファー内のデータがフラッシュされ、基本的に Flush メソッドが呼び出されます。 Dispose は、ファイル ハンドル、ネットワーク接続、内部バッファリングに使用されるメモリなどのオペレーティング システム リソースも解放します。 BufferedStream クラスは、読み取りと書き込みのパフォーマンスを向上させるために、バッファーされたストリームを別のストリームにラップする機能を提供します。

.NET Framework 4.5 以降、Stream クラスには非同期操作を簡略化するための非同期メソッドが含まれています。 非同期メソッドの名前には、ReadAsync、WriteAsync、CopyToAsync、FlushAsyncなどの Async が含まれています。 これらのメソッドを使用すると、メイン スレッドをブロックすることなく、リソースを大量に消費する I/O 操作を実行できます。 このパフォーマンスの考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないかのように表示される Windows 8.x ストア アプリまたはデスクトップ アプリで特に重要です。 非同期メソッドは、Visual Basic および C# の async キーワードと await キーワードと組み合わせて使用されます。

Windows 8.x ストア アプリで使用する場合、Stream には、AsInputStream と AsOutputStreamの 2 つの拡張メソッドが含まれています。 これらのメソッドは、Stream オブジェクトを Windows ランタイムのストリームに変換します。 AsStreamForRead メソッドと AsStreamForWrite メソッドを使用して、Windows ランタイムのストリームを Stream オブジェクトに変換することもできます。 詳細については、「方法: .NET Framework ストリームと Windows ランタイム ストリーム間で変換する

一部のストリーム実装では、基になるデータのローカル バッファリングが実行され、パフォーマンスが向上します。 このようなストリームの場合は、Flush または FlushAsync メソッドを使用して、内部バッファーをクリアし、すべてのデータが基になるデータ ソースまたはリポジトリに確実に書き込まれるようにすることができます。

バッキング ストアのないストリーム (ビット バケットとも呼ばれます) が必要な場合は、Null フィールドを使用して、この目的のために設計されたストリームのインスタンスを取得します。

注意 (実装者)

Streamの派生クラスを実装する場合は、Read(Byte[], Int32, Int32) メソッドと Write(Byte[], Int32, Int32) メソッドの実装を指定する必要があります。 非同期メソッド ReadAsync(Byte[], Int32, Int32)、WriteAsync(Byte[], Int32, Int32)、および CopyToAsync(Stream) は、実装で Read(Byte[], Int32, Int32) および Write(Byte[], Int32, Int32) 同期メソッドを使用します。 したがって、Read(Byte[], Int32, Int32) と Write(Byte[], Int32, Int32) の実装は、非同期メソッドで正しく動作します。 ReadByte() と WriteByte(Byte) の既定の実装では、新しい単一要素のバイト配列を作成し、Read(Byte[], Int32, Int32) と Write(Byte[], Int32, Int32)の実装を呼び出します。 Streamから派生する場合は、パフォーマンスを大幅に向上させるために、内部バッファーがある場合は、これらのメソッドをオーバーライドして内部バッファーにアクセスすることをお勧めします。 また、CanRead、CanSeek、CanWrite、Flush()、Length、Position、Seek(Int64, SeekOrigin)、および SetLength(Int64)の実装を提供する必要があります。

Close() メソッドをオーバーライドしないでください。代わりに、すべての Stream クリーンアップ ロジックを Dispose(Boolean) メソッドに配置します。 詳細については、「 Dispose メソッドの実装」を参照してください。

コンストラクター

フィールド

プロパティ

メソッド

明示的なインターフェイスの実装

拡張メソッド

適用対象

こちらもご覧ください

• FileStream
• MemoryStream
• BufferedStream
• ファイルおよびストリーム I/O
• 方法: .NET Framework ストリームと Windows ランタイム ストリームの間で変換