FileStream クラス

定義

名前空間:

System.IO

アセンブリ:

netstandard.dll, System.Runtime.dll

ソース:

FileStream.cs

同期および非同期の読み取りと書き込みの両方の操作をサポートするファイルの Stream を提供します。

public ref class FileStream : System::IO::Stream

public class FileStream : System.IO.Stream

type FileStream = class
    inherit Stream

Public Class FileStream
Inherits Stream

継承

Object

MarshalByRefObject

Stream

FileStream

派生

System.IO.IsolatedStorage.IsolatedStorageFileStream

例

次の例では、 FileStream コンストラクターの一部を示します。

using System;
using System.IO;
using System.Text;

class Test
{

    public static void Main()
    {
        string path = @"c:\temp\MyTest.txt";

        // Delete the file if it exists.
        if (File.Exists(path))
        {
            File.Delete(path);
        }

        //Create the file.
        using (FileStream fs = File.Create(path))
        {
            AddText(fs, "This is some text");
            AddText(fs, "This is some more text,");
            AddText(fs, "\r\nand this is on a new line");
            AddText(fs, "\r\n\r\nThe following is a subset of characters:\r\n");

            for (int i=1;i < 120;i++)
            {
                AddText(fs, Convert.ToChar(i).ToString());
            }
        }

        //Open the stream and read it back.
        using (FileStream fs = File.OpenRead(path))
        {
            byte[] b = new byte[1024];
            UTF8Encoding temp = new UTF8Encoding(true);
            int readLen;
            while ((readLen = fs.Read(b,0,b.Length)) > 0)
            {
                Console.WriteLine(temp.GetString(b,0,readLen));
            }
        }
    }

    private static void AddText(FileStream fs, string value)
    {
        byte[] info = new UTF8Encoding(true).GetBytes(value);
        fs.Write(info, 0, info.Length);
    }
}

open System
open System.IO
open System.Text

let addText (fs:FileStream) (value: string) =
    let info = UTF8Encoding(true).GetBytes value
    fs.Write(info, 0, info.Length);

let path = @"c:\temp\MyTest.txt"

// Delete the file if it exists.
if File.Exists path then
    File.Delete path

//Create the file.
do
    use fs = File.Create path

    addText fs "This is some text"
    addText fs "This is some more text,"
    addText fs "\r\nand this is on a new line"
    addText fs "\r\n\r\nThe following is a subset of characters:\r\n"

    for i = 1 to 119 do
        Convert.ToChar i
        |> string
        |> addText fs
    
do
    //Open the stream and read it back.
    use fs = File.OpenRead path
    let b = Array.zeroCreate 1024
    let temp = UTF8Encoding true
    let mutable readLen = fs.Read(b,0,b.Length);
    while readLen> 0 do
        printfn $"{temp.GetString(b,0,readLen)}"
        readLen <- fs.Read(b,0,b.Length)

Imports System.IO
Imports System.Text

Public Class Test

    Public Shared Sub Main()
        Dim path As String = "c:\temp\MyTest.txt"

        ' Delete the file if it exists.
        If File.Exists(path) Then
            File.Delete(path)
        End If

        'Create the file.
        Dim fs As FileStream = File.Create(path)

        AddText(fs, "This is some text")
        AddText(fs, "This is some more text,")
        AddText(fs, Environment.NewLine & "and this is on a new line")
        AddText(fs, Environment.NewLine & Environment.NewLine)
        AddText(fs, "The following is a subset of characters:" & Environment.NewLine)

        Dim i As Integer

        For i = 1 To 120
            AddText(fs, Convert.ToChar(i).ToString())

        Next

        fs.Close()

        'Open the stream and read it back.
        fs = File.OpenRead(path)
        Dim b(1023) As Byte
        Dim temp As UTF8Encoding = New UTF8Encoding(True)

        Do While fs.Read(b, 0, b.Length) > 0
            Console.WriteLine(temp.GetString(b))
        Loop

        fs.Close()
    End Sub

    Private Shared Sub AddText(ByVal fs As FileStream, ByVal value As String)
        Dim info As Byte() = New UTF8Encoding(True).GetBytes(value)
        fs.Write(info, 0, info.Length)
    End Sub
End Class

次の例は、ファイルに非同期的に書き込む方法を示しています。 このコードは、UserInput という名前の TextBlock と、Button_Clickという名前の Click イベント ハンドラーにフックされたボタンを持つWPF アプリで実行されます。 ファイル パスは、コンピューター上に存在するファイルに変更する必要があります。

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

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

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            UnicodeEncoding uniencoding = new UnicodeEncoding();
            string filename = @"c:\Users\exampleuser\Documents\userinputlog.txt";

            byte[] result = uniencoding.GetBytes(UserInput.Text);

            using (FileStream SourceStream = File.Open(filename, FileMode.OpenOrCreate))
            {
                SourceStream.Seek(0, SeekOrigin.End);
                await SourceStream.WriteAsync(result, 0, result.Length);
            }
        }
    }
}

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim uniencoding As UnicodeEncoding = New UnicodeEncoding()
        Dim filename As String = "c:\Users\exampleuser\Documents\userinputlog.txt"

        Dim result As Byte() = uniencoding.GetBytes(UserInput.Text)

        Using SourceStream As FileStream = File.Open(filename, FileMode.OpenOrCreate)
            SourceStream.Seek(0, SeekOrigin.End)
            Await SourceStream.WriteAsync(result, 0, result.Length)
        End Using
    End Sub
End Class

注釈

FileStream クラスを使用して、ファイル システム上のファイルの読み取り、書き込み、開き、閉じる、パイプ、標準入力、標準出力などの他のファイル関連オペレーティング システム ハンドルを操作します。 Read、Write、CopyTo、およびFlushメソッドを使用して同期操作を実行したり、非同期操作を実行するReadAsync、WriteAsync、CopyToAsync、FlushAsyncメソッドを使用したりできます。 非同期メソッドを使用して、メイン スレッドをブロックせずにリソースを集中的に使用するファイル操作を実行します。 このパフォーマンスの考慮事項は、時間のかかるストリーム操作によって UI スレッドがブロックされ、アプリが動作していないかのように表示されるデスクトップ アプリで特に重要です。 FileStream は、パフォーマンスを向上させるために入力と出力をバッファーします。

Important

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

IsAsync プロパティは、ファイル ハンドルが非同期的に開かれたかどうかを検出します。 この値は、FileStream、isAsync、またはuseAsync パラメーターを持つコンストラクターを使用して、options クラスのインスタンスを作成するときに指定します。 プロパティが trueされると、ストリームは重複した I/O を使用してファイル操作を非同期的に実行します。 ただし、IsAsync プロパティは、true、ReadAsync、またはWriteAsyncメソッドを呼び出すためにCopyToAsyncする必要はありません。 IsAsync プロパティがfalseされ、非同期の読み取りおよび書き込み操作を呼び出しても、UI スレッドはブロックされませんが、実際の I/O 操作は同期的に実行されます。

Seekメソッドは、ファイルへのランダム アクセスをサポートします。 Seek では、読み取り/書き込み位置をファイル内の任意の位置に移動できます。 これは、バイト オフセット参照ポイント パラメーターを使用して行われます。 バイト オフセットは、シーク参照ポイントに対する相対位置であり、基になるファイルの先頭、現在の位置、または末尾である可能性があります。これは、 SeekOrigin 列挙体の 3 つのメンバーによって表されます。

Note

ディスク ファイルは常にランダム アクセスをサポートします。 構築時に、 CanSeek プロパティの値は、基になるファイルの種類に応じて true または false に設定されます。 winbase.h で定義されているように、基になるファイルの種類がFILE_TYPE_DISKされている場合、 CanSeek プロパティの値は true。 それ以外の場合、 CanSeek プロパティの値は false。

プロセスがファイルの一部をロックして終了するか、未処理のロックを持つファイルを閉じると、動作は未定義になります。

ディレクトリ操作とその他のファイル操作については、 File、 Directory、および Path クラスを参照してください。 File クラスは、主にファイル パスに基づいてFileStream オブジェクトを作成するための静的メソッドを持つユーティリティ クラスです。 MemoryStream クラスは、バイト配列からストリームを作成し、FileStream クラスに似ています。

一般的なファイル操作とディレクトリ操作の一覧については、「 一般的な I/O タスク」を参照してください。

ストリーム位置の変化の検出

FileStream オブジェクトのハンドルが排他的に保持されていない場合、別のスレッドが同時にファイル ハンドルにアクセスし、ファイル ハンドルに関連付けられているオペレーティング システムのファイル ポインターの位置を変更できます。 この場合、 FileStream オブジェクト内のキャッシュされた位置とバッファー内のキャッシュされたデータが侵害される可能性があります。 FileStream オブジェクトは、キャッシュされたバッファーにアクセスするメソッドのチェックを定期的に実行して、オペレーティング システムのハンドル位置が、FileStream オブジェクトで使用されるキャッシュされた位置と同じであることを確認します。

Read メソッドの呼び出しでハンドル位置の予期しない変更が検出された場合、.NET はバッファーの内容を破棄し、ファイルからストリームを再度読み取ります。 これは、ファイルのサイズや、ファイル ストリームの位置に影響する可能性があるその他のプロセスによっては、パフォーマンスに影響を与える可能性があります。

Write メソッドの呼び出しでハンドル位置の予期しない変更が検出された場合、バッファーの内容は破棄され、IOException例外がスローされます。

FileStream オブジェクトは、ハンドルを公開するために SafeFileHandle プロパティにアクセスするか、FileStream オブジェクトにそのコンストラクターに SafeFileHandle プロパティが与えられている場合、そのハンドルを排他的に保持しません。

コンストラクター

名前	説明
FileStream(IntPtr, FileAccess, Boolean, Int32, Boolean)	古い. 指定した読み取り/書き込みアクセス許可、FileStreamインスタンスの所有権、バッファー サイズ、および同期または非同期の状態を使用して、指定したファイル ハンドルのFileStream クラスの新しいインスタンスを初期化します。
FileStream(IntPtr, FileAccess, Boolean, Int32)	古い. 指定した読み取り/書き込みアクセス許可、FileStream インスタンスの所有権、バッファー サイズを使用して、指定したファイル ハンドルのFileStream クラスの新しいインスタンスを初期化します。
FileStream(IntPtr, FileAccess, Boolean)	古い. 指定した読み取り/書き込みアクセス許可とFileStreamインスタンスの所有権を使用して、指定したファイル ハンドルのFileStream クラスの新しいインスタンスを初期化します。
FileStream(IntPtr, FileAccess)	古い. 指定した読み取り/書き込みアクセス許可を使用して、指定したファイル ハンドルの FileStream クラスの新しいインスタンスを初期化します。
FileStream(SafeFileHandle, FileAccess, Int32, Boolean)	指定した読み取り/書き込みアクセス許可、バッファー サイズ、および同期または非同期の状態を使用して、指定したファイル ハンドルの FileStream クラスの新しいインスタンスを初期化します。
FileStream(SafeFileHandle, FileAccess, Int32)	指定した読み取り/書き込みアクセス許可とバッファー サイズを使用して、指定したファイル ハンドルの FileStream クラスの新しいインスタンスを初期化します。
FileStream(SafeFileHandle, FileAccess)	指定した読み取り/書き込みアクセス許可を使用して、指定したファイル ハンドルの FileStream クラスの新しいインスタンスを初期化します。
FileStream(String, FileMode, FileAccess, FileShare, Int32, Boolean)	指定したパス、作成モード、読み取り/書き込みおよび共有のアクセス許可、バッファー サイズ、および同期または非同期の状態を使用して、 FileStream クラスの新しいインスタンスを初期化します。
FileStream(String, FileMode, FileAccess, FileShare, Int32, FileOptions)	指定したパス、作成モード、読み取り/書き込みおよび共有のアクセス許可を使用して、 FileStream クラスの新しいインスタンスを初期化します。他の FileStream へのアクセスは、同じファイル、バッファー サイズ、および追加のファイル オプションに対して持つことができます。
FileStream(String, FileMode, FileAccess, FileShare, Int32)	指定したパス、作成モード、読み取り/書き込みおよび共有のアクセス許可、バッファー サイズを使用して、 FileStream クラスの新しいインスタンスを初期化します。
FileStream(String, FileMode, FileAccess, FileShare)	指定したパス、作成モード、読み取り/書き込みアクセス許可、および共有アクセス許可を使用して、 FileStream クラスの新しいインスタンスを初期化します。
FileStream(String, FileMode, FileAccess)	指定したパス、作成モード、および読み取り/書き込みアクセス許可を使用して、 FileStream クラスの新しいインスタンスを初期化します。
FileStream(String, FileMode)	指定したパスと作成モードを使用して、 FileStream クラスの新しいインスタンスを初期化します。
FileStream(String, FileStreamOptions)	指定したパス、作成モード、読み取り/書き込みおよび共有アクセス許可、バッファー サイズ、追加のファイル オプション、事前割り当てサイズ、および他の FileStream が同じファイルに対して持つアクセス権を使用して、 FileStream クラスの新しいインスタンスを初期化します。

プロパティ

名前	説明
CanRead	現在のストリームが読み取りをサポートしているかどうかを示す値を取得します。
CanSeek	現在のストリームがシークをサポートしているかどうかを示す値を取得します。
CanTimeout	現在のストリームがタイムアウトできるかどうかを決定する値を取得します。 (継承元 Stream)
CanWrite	現在のストリームが書き込みをサポートしているかどうかを示す値を取得します。
Handle	古い. 現在の FileStream オブジェクトがカプセル化するファイルのオペレーティング システム ファイル ハンドルを取得します。
IsAsync	FileStreamが非同期的に開かれたか、同期的に開かれたかを示す値を取得します。
Length	ストリームの長さをバイト単位で取得します。
Name	FileStreamで開かれたファイルの絶対パスを取得します。
Position	このストリームの現在位置を取得または設定します。
ReadTimeout	ストリームがタイムアウトするまでの読み取りを試行する時間を決定する値をミリ秒単位で取得または設定します。 (継承元 Stream)
SafeFileHandle	現在のSafeFileHandle オブジェクトがカプセル化するファイルのオペレーティング システム ファイル ハンドルを表すFileStream オブジェクトを取得します。
WriteTimeout	ストリームがタイムアウトするまでの書き込みを試行する時間を決定する値をミリ秒単位で取得または設定します。 (継承元 Stream)

メソッド

名前	説明
BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	非同期読み取り操作を開始します。 代わりに ReadAsync(Byte[], Int32, Int32, CancellationToken) を使用することを検討してください。
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	非同期書き込み操作を開始します。 代わりに WriteAsync(Byte[], Int32, Int32, CancellationToken) を使用することを検討してください。
Close()	現在のストリームを閉じ、現在のストリームに関連付けられているリソース (ソケットやファイル ハンドルなど) を解放します。 このメソッドを呼び出す代わりに、ストリームが適切に破棄されていることを確認します。 (継承元 Stream)
CopyTo(Stream, Int32)	現在のストリームからバイトを読み取り、指定されたバッファー サイズを使用して別のストリームに書き込みます。 どちらのストリーム位置も、コピーされたバイト数だけ進みます。
CopyTo(Stream)	現在のストリームからバイトを読み取り、別のストリームに書き込みます。 どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CopyToAsync(Stream, CancellationToken)	現在のストリームからバイトを非同期に読み取り、指定されたキャンセル トークンを使用して別のストリームに書き込みます。 どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CopyToAsync(Stream, Int32, CancellationToken)	指定したバッファー サイズとキャンセル トークンを使用して、現在のファイル ストリームからバイトを非同期に読み取り、別のストリームに書き込みます。
CopyToAsync(Stream, Int32)	現在のストリームからバイトを非同期に読み取り、指定されたバッファー サイズを使用して別のストリームに書き込みます。 どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CopyToAsync(Stream)	現在のストリームからバイトを非同期に読み取り、別のストリームに書き込みます。 どちらのストリーム位置も、コピーされたバイト数だけ進みます。 (継承元 Stream)
CreateWaitHandle()	古い. WaitHandle オブジェクトを割り当てます。 (継承元 Stream)
Dispose()	Streamで使用されているすべてのリソースを解放します。 (継承元 Stream)
Dispose(Boolean)	FileStreamによって使用されるアンマネージ リソースを解放し、必要に応じてマネージド リソースを解放します。
DisposeAsync()	FileStreamによって使用されるアンマネージ リソースを非同期的に解放します。
EndRead(IAsyncResult)	保留中の非同期読み取り操作が完了するまで待機します。 (代わりに ReadAsync(Byte[], Int32, Int32, CancellationToken) を使用することを検討してください)。
EndWrite(IAsyncResult)	非同期書き込み操作を終了し、I/O 操作が完了するまでブロックします。 (代わりに WriteAsync(Byte[], Int32, Int32, CancellationToken) を使用することを検討してください)。
Equals(Object)	指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
Finalize()	ガベージ コレクターが FileStreamを回収するときに、リソースが解放され、その他のクリーンアップ操作が実行されるようにします。
Flush()	このストリームのバッファーをクリアし、バッファー内のデータをファイルに書き込みます。
Flush(Boolean)	このストリームのバッファーをクリアし、バッファー内のデータをファイルに書き込み、すべての中間ファイル バッファーもクリアします。
FlushAsync()	このストリームのすべてのバッファーを非同期的にクリアし、バッファー内のデータを基になるデバイスに書き込みます。 (継承元 Stream)
FlushAsync(CancellationToken)	このストリームのすべてのバッファーを非同期にクリアし、バッファー内のデータをファイルに書き込み、取り消し要求を監視します。
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetLifetimeService()	古い. このインスタンスの有効期間ポリシーを制御する現在の有効期間サービス オブジェクトを取得します。 (継承元 MarshalByRefObject)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
InitializeLifetimeService()	古い. このインスタンスの有効期間ポリシーを制御する有効期間サービス オブジェクトを取得します。 (継承元 MarshalByRefObject)
Lock(Int64, Int64)	他のプロセスが FileStreamに対する読み取りまたは書き込みを行わないようにします。
MemberwiseClone()	現在の Objectの簡易コピーを作成します。 (継承元 Object)
MemberwiseClone(Boolean)	現在の MarshalByRefObject オブジェクトの簡易コピーを作成します。 (継承元 MarshalByRefObject)
ObjectInvariant()	古い. Contractのサポートを提供します。 (継承元 Stream)
Read(Byte[], Int32, Int32)	ストリームからバイト ブロックを読み取り、特定のバッファーにデータを書き込みます。
Read(Span<Byte>)	現在のファイル ストリームからバイト シーケンスを読み取り、読み取ったバイト数だけファイル ストリーム内の位置を進めます。
ReadAsync(Byte[], Int32, Int32, CancellationToken)	現在のファイル ストリームからバイト シーケンスを非同期に読み取り、指定したオフセットから始まるバイト配列に書き込み、読み取ったバイト数だけファイル ストリーム内の位置を進め、取り消し要求を監視します。
ReadAsync(Byte[], Int32, Int32)	現在のストリームからバイト シーケンスを非同期に読み取り、ストリーム内の位置を読み取ったバイト数だけ進めます。 (継承元 Stream)
ReadAsync(Memory<Byte>, CancellationToken)	現在のファイル ストリームからバイト シーケンスを非同期に読み取り、メモリ領域に書き込み、読み取ったバイト数だけファイル ストリーム内の位置を進め、キャンセル要求を監視します。
ReadAtLeast(Span<Byte>, Int32, Boolean)	現在のストリームから少なくともバイト数を読み取り、読み取ったバイト数だけストリーム内の位置を進めます。 (継承元 Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	現在のストリームから少なくとも最小バイト数を非同期に読み取り、読み取ったバイト数だけストリーム内の位置を進め、キャンセル要求を監視します。 (継承元 Stream)
ReadByte()	ファイルからバイトを読み取り、読み取り位置を 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)
Unlock(Int64, Int64)	以前にロックされていたファイルのすべてまたは一部への他のプロセスによるアクセスを許可します。
Write(Byte[], Int32, Int32)	バイト ブロックをファイル ストリームに書き込みます。
Write(ReadOnlySpan<Byte>)	読み取り専用スパンから現在のファイル ストリームにバイト シーケンスを書き込み、書き込まれたバイト数だけこのファイル ストリーム内の現在の位置を進めます。
WriteAsync(Byte[], Int32, Int32, CancellationToken)	現在のストリームにバイトシーケンスを非同期に書き込み、書き込まれたバイト数だけこのストリーム内の現在位置を進め、キャンセル要求を監視します。
WriteAsync(Byte[], Int32, Int32)	現在のストリームにバイト シーケンスを非同期に書き込み、書き込まれたバイト数だけこのストリーム内の現在位置を進めます。 (継承元 Stream)
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	メモリ領域から現在のファイル ストリームにバイトシーケンスを非同期に書き込み、書き込まれたバイト数だけこのファイル ストリーム内の現在位置を進め、キャンセル要求を監視します。
WriteByte(Byte)	ファイル ストリーム内の現在位置にバイトを書き込みます。

拡張メソッド

名前	説明
ConfigureAwait(IAsyncDisposable, Boolean)	非同期破棄から返されるタスクの待機を実行する方法を構成します。
CopyToAsync(Stream, PipeWriter, CancellationToken)	キャンセル トークンを使用して、 Stream からバイトを非同期に読み取り、指定した PipeWriterに書き込みます。
GetAccessControl(FileStream)	ファイルのセキュリティ情報を返します。
SetAccessControl(FileStream, FileSecurity)	既存のファイルのセキュリティ属性を変更します。

こちらもご覧ください

• File
• FileAccess
• FileMode
• FileShare
• ファイルおよびストリーム入出力
• 方法: ファイルからテキストを読み取る
• 方法: ファイルにテキストを書き込む
• 方法: 新しく作成されたデータ ファイルの読み取りと書き込み