My.Computer.FileSystem.OpenTextFileWriter メソッド

[アーティクル]
08/16/2008

更新 : 2007 年 11 月

StreamWriter を開きます。

' Usage
Dim value As System.IO.StreamWriter = My.Computer.FileSystem.OpenTextFileWriter(file ,append)
Dim value As System.IO.StreamWriter = My.Computer.FileSystem.OpenTextFileWriter(file ,append ,encoding)
' Declaration
Public Function OpenTextFileWriter( _
   ByVal file As String, _
   ByVal append As Boolean _
) As System.IO.StreamWriter
' -or-
Public Function OpenTextFileWriter( _
   ByVal file As String, _
   ByVal append As Boolean, _
   ByVal encoding As System.Text.Encoding _
) As System.IO.StreamWriter

パラメータ

file
必ず指定します。書き込むファイルを指定する文字列 String です。
append
情報をファイルに追加するか、ファイル全体を情報で上書きするかを指定する Boolean です。必ず指定します。
encoding
ファイルの書き込みに使用するエンコーディングを示す Encoding です。既定値は UTF8 です。

戻り値

StreamWriter

例外

例外がスローされる可能性のある状態を次に示します。

ファイル名がスラッシュ (ArgumentException) で終わる。

解説

OpenTextFileWriter メソッドは、ファイルのストリームを開いて初期化し、そのストリームの StreamWriter オブジェクトを返します。ストリームには、必要な回数書き込み、終了したら閉じることができます。

メモ :
すべてのデータを基になるストリームに正しく書き込むためには、StreamWriter オブジェクトで Close メソッドを呼び出す必要があります。

append パラメータが True の場合にテキストはファイルに追加され、それ以外の場合はファイル内の既存テキストが上書きされます。

少量の文字列だけをファイルに書き込む場合は、WriteAllText メソッドを使用した方が簡単なことがあります。詳細については、「My.Computer.FileSystem.WriteAllText メソッド」を参照してください。

処理手順

My.Computer.FileSystem.OpenTextFileWriter メソッドに関連するタスクの例を次の表に示します。

タスク	参照項目
StreamWriter を使用してファイルにテキストを書き込む	方法 : Visual Basic で StreamWriter を使用してテキストをファイルに書き込む

使用例

この例では、My.Computer.FileSystem.OpenTextFileWriter メソッドで StreamWriter を開き、StreamWriter クラスの WriteLine メソッドを使用して文字列をテキストファイルに書き込んでいます。

Dim file As System.IO.StreamWriter
file = My.Computer.FileSystem.OpenTextFileWriter("c:\test.txt", True)
file.WriteLine("Here is the first string.")
file.Close()

必要条件

名前空間 : Microsoft.VisualBasic.MyServices

クラス : FileSystemProxy (FileSystem へのアクセスを可能にします)

アセンブリ : Microsoft Visual Basic ランタイム (Microsoft.VisualBasic.dll 内)

プロジェクトの種類別の使用可/不可

プロジェクトの種類	使用可能
Windows アプリケーション	○
クラスライブラリ	○
コンソールアプリケーション	○
Windows コントロールライブラリ	○
Web コントロールライブラリ	○
Windows サービス	○
Web サイト	○