File

ファイル オブジェクトは、ディスク上のファイルへのアクセスや読み書きの機能を提供します。このオブジェクトを使って、プログラム上の複数のセッションから設定を保存したり開いたりすることができます。

Properties

LastError

File.LastError

最後のファイル操作エラーのメッセージを設定または取得します。このプロパティは、何かの機能がいつ実行に失敗したかを調べるのに役立ちます。

Operations

ReadContents

File.ReadContents(filePath)

ファイルを開いてそのファイル全体の内容を読み込みます。この機能は 1 MB 以下の小さなファイルに対しては高速に動作しますが、10 MB 以上のファイルに対しては速度が落ちます。

filePath

読み込むファイルの完全パスです。完全パスは、たとえば c:\temp\settings.data のような形式です。

Returns

ファイル全体の内容。

WriteContents

File.WriteContents(filePath, contents)

ファイルを開いて、指定された内容をそのファイルに書き込みます。元の内容は新しい内容に置き換えられます。

filePath

書き込み対象のファイルの完全パスです。 完全パスは、たとえば c:\temp\settings.data のような形式です。

contents

指定されたファイルに書き込まれる内容。

Returns

操作が成功した場合は、 "SUCCESS" を返します。それ以外の場合には "FAILED" を返します。

ReadLine

File.ReadLine(filePath, lineNumber)

指定されたファイルを開いて、指定された行番号まで読み込みます。

filePath

読み込むファイルの完全パスです。完全パスは、たとえば c:\temp\settings.data のような形式です。

lineNumber

読み込むテキストの行番号。

Returns

指定されたファイルの指定された行のテキストです。

WriteLine

File.WriteLine(filePath, lineNumber, contents)

指定されたファイルを開いて、指定された行番号で書き込みを行います。 この操作は現在の内容を指定行まで上書きします。

filePath

読み込むファイルの完全パスです。完全パスは、たとえば c:\temp\settings.data のような形式です。

lineNumber

書き込むテキストの行番号。

contents

指定されたファイルの指定された行に書き込まれる内容。

Returns

操作が成功した場合は、 "SUCCESS" を返します。それ以外の場合には "FAILED" を返します。

InsertLine

File.InsertLine(filePath, lineNumber, contents)

指定されたファイルを開いて指定された行番号のところにその内容を挿入します。 この操作を行っても、指定行の現在の内容は上書きされません。

filePath

読み込むファイルの完全パスです。完全パスは、たとえば c:\temp\settings.data のような形式です。

lineNumber

挿入されるテキストの行番号。

contents

ファイルに挿入される内容。

Returns

操作が成功した場合は、 "SUCCESS" を返します。それ以外の場合には "FAILED" を返します。

AppendContents

File.AppendContents(filePath, contents)

指定されたファイルを開いてそのファイルの末尾に内容を追加します。

filePath

読み込むファイルの完全パスです。完全パスは、たとえば c:\temp\settings.data のような形式です。

contents

ファイルの末尾に追加される内容です。

Returns

操作が成功した場合は、 "SUCCESS" を返します。それ以外の場合には "FAILED" を返します。

CopyFile

File.CopyFile(sourceFilePath, destinationFilePath)

指定されたソース ファイルを転送先のファイル パスにコピーします。転送先のポイントが存在しない場合は、自動的にそのポイントを作成することを試みます。 現在あるファイルは上書きされます。ファイルが上書きされないようにするために、転送先にファイルがあるかどうかを確認してください。

sourceFilePath

コピーする必要のあるファイルの完全パスです。完全パスは、たとえばc:\temp\settings.data のような形式です。

destinationFilePath

ファイル パスもしくは移動先の場所。

Returns

操作が成功した場合は、 "SUCCESS" を返します。それ以外の場合には "FAILED" を返します。

DeleteFile

File.DeleteFile(filePath)

指定されたファイルを削除します。

filePath

転送先の場所もしくはファイルのパスです。完全パスは、たとえば c:\temp\settings.data のような形式です。

Returns

操作が成功した場合は、 "SUCCESS" を返します。それ以外の場合には "FAILED" を返します。

CreateDirectory

File.CreateDirectory(directoryPath)

指定されたディレクトリを作成します。

directoryPath

作成されるディレクトリの完全パス。

Returns

操作が成功した場合は、 "SUCCESS" を返します。それ以外の場合には "FAILED" を返します。

DeleteDirectory

File.DeleteDirectory(directoryPath)

指定されたディレクトリを削除します。

directoryPath

削除されるディレクトリの完全パスです。

Returns

操作が成功した場合は、 "SUCCESS" を返します。それ以外の場合には "FAILED" を返します。

GetFiles

File.GetFiles(directoryPath)

指定されたディレクトリ内のすべてのファイルのパスを取得します。

directoryPath

ファイルを探す対象のディレクトリ。

Returns

操作が成功した場合は、 "SUCCESS" を返します。それ以外の場合には "FAILED" を返します。

GetDirectories

File.GetDirectories(directoryPath)

指定されたディレクトリ内のすべてのディレクトリのパスを取得します。

directoryPath

サブディレクトリを探す対象ディレクトリ。

Returns

操作が成功した場合は、 "SUCCESS" を返します。それ以外の場合には "FAILED" を返します。

GetTemporaryFilePath

File.GetTemporaryFilePath()

新しい一時ファイルを一時ディレクトリ内に作成して そのファイルの完全パスを返します。

Returns

一時ファイルの完全パスです。

GetSettingsFilePath

File.GetSettingsFilePath()

このプログラムの設定ファイルの完全パスを取得します。設定ファイルの名前はプログラムの名前に基づいており、プログラムと同じ場所に置かれます。

Returns

このプログラムの設定ファイルの完全パス。