StreamWriter.AutoFlush プロパティとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

StreamWriter.AutoFlush プロパティ

StreamWriter.Write が呼び出されるたびに、StreamWriter によって基になるストリームに対するバッファをフラッシュするかどうかを示す値を取得または設定します。

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

Visual Basic (宣言)

Public Overridable Property
 AutoFlush As Boolean

Visual Basic (使用法)

Dim instance As StreamWriter
Dim value As Boolean

value = instance.AutoFlush

instance.AutoFlush = value

public virtual bool AutoFlush { get;
 set; }

C++

public:
virtual property bool AutoFlush {
    bool get ();
    void set (bool value);
}

/** @property */
public boolean get_AutoFlush ()

/** @property */
public void set_AutoFlush (boolean value)

JScript

public function get AutoFlush
 () : boolean

public function set AutoFlush
 (value : boolean)

プロパティ値
StreamWriter に強制的にバッファをフラッシュさせる場合は true。それ以外の場合は false。

解説

ストリームをフラッシュしても、Flush または Close を明示的に呼び出さない限り、そのストリームの基になるエンコーダはフラッシュされません。AutoFlush を true に設定すると、データがバッファからストリームにフラッシュされますが、エンコーダの状態はフラッシュされません。これにより、エンコーダの状態 (一部の文字) を維持できるため、次のブロックの文字を正確にエンコードできるようになります。この動作は、一部の文字をエンコードするためにはエンコーダがあらかじめその文字に隣接する文字を受け取っておく必要がある UTF8 および UTF7 に対して有効です。

AutoFlush が false に設定されている場合、StreamWriter は最低限のバッファリングだけを行います。バッファリングは、指定されたエンコーディングに基づいてエンコーダで内部的に暗黙的に実行されます。StreamWriter による書き込みの終了時に常に Close (または、少なくとも Flush) を呼び出すことを前提にして、AutoFlush を false に設定すると、パフォーマンスが向上することがあります。

たとえば、ユーザーがすぐにフィードバックを必要とする場合にデバイスに書き込むときは、AutoFlush を true に設定します。Console.Out がその例です。Console への書き込みのために内部で使用される StreamWriter は、StreamWriter.Write が呼び出されるたびにエンコーダの状態以外のすべての内部状態をフラッシュします。

このプロパティの使用例については、以下の「使用例」を参照してください。その他の一般的な I/O タスクまたは関連する I/O タスクの例を次の表に示します。

実行するタスク	参考例があるトピック
テキストファイルを作成する。	方法 : ファイルにテキストを書き込む
テキストファイルに書き込む。	方法 : ファイルにテキストを書き込む
テキストファイルから読み取る。	方法 : ファイルからテキストを読み取る

使用例

AutoFlush プロパティを使用するための構文の例を次に示します。

Visual Basic

' Gets or sets a value indicating whether the StreamWriter
' will flush its buffer to the underlying stream after every 
' call to StreamWriter.Write.
Sw.AutoFlush = True

// Gets or sets a value indicating whether the StreamWriter
// will flush its buffer to the underlying stream after every 
// call to StreamWriter.Write.
sw.AutoFlush = true;

C++

// Gets or sets a value indicating whether the StreamWriter
// will flush its buffer to the underlying stream after every 
// call to StreamWriter.Write.
sw->AutoFlush = true;

// Gets or sets a value indicating whether the StreamWriter
// will flush its buffer to the underlying stream after every 
// call to StreamWriter.Write.
sw.set_AutoFlush(true);