猿頁

Fileオブジェクトは、ディスク上のファイルに対して読み書きする機能を提供します。

---

AppendContents

オペレーション : AppendContents ( filePath , contents )

指定したファイルの最後に文字列を追加します。

filePath	文字列	書き出すファイルのフルパス。 フルパスは「c:\temp\settings.data」のように記述します。
contents	文字列	ファイルの最後に追加する文字列。
戻り値	文字列	書き出しが成功した場合は"SUCCESS"、失敗した場合は"FAILED"。
対応バージョン		v0.8～

CopyFile

オペレーション : CopyFile ( sourceFilePath , destinationFilePath )

指定したファイルをコピーします。
コピー先に存在しないパスを指定した場合は、そのパスを作成します。
現在あるファイルであれば上書きされます。
ファイルが上書きされないようにするために、事前に転送先にファイルがあるかどうかを確認してください。

sourceFilePath	文字列	コピーするファイルのフルパス。 フルパスは「c:\temp\settings.data」のように記述します。
destinationFilePath	文字列	コピー先のフォルダまたはファイルのパス。
戻り値	文字列	コピーが成功した場合は"SUCCESS"、失敗した場合は"FAILED"。
対応バージョン		v0.8～

CreateDirectory

オペレーション : CreateDirectory ( directoryPath )

指定したフォルダを作成します。

directoryPath	文字列	作成するフォルダのフルパス。
戻り値	文字列	作成が成功した場合は"SUCCESS"が、失敗した場合は"FAILED"。
対応バージョン		v0.8～

DeleteDirectory

オペレーション : DeleteDirectory ( directoryPath )

指定したフォルダを削除します。

directoryPath	文字列	削除するフォルダのフルパス。
戻り値	文字列	削除が成功した場合は"SUCCESS"、失敗した場合は"FAILED"。
対応バージョン		v0.8～

DeleteFile

オペレーション : DeleteFile ( filePath )

指定したフォルダを削除します。

filePath	文字列	削除するファイルのフルパス。
戻り値	文字列	削除が成功した場合は"SUCCESS"、失敗した場合は"FAILED"。
対応バージョン		v0.8～

GetDirectories

オペレーション : GetDirectories ( directoryPath )

指定したフォルダ内のすべてのフォルダのパスを取得します。

directoryPath	文字列	フォルダを探す対象のフォルダ。
戻り値	文字列	操作が成功した場合はフォルダ名(配列)、失敗した場合は"FAILED"。
対応バージョン		v0.8～

GetFiles

オペレーション : GetFiles ( directoryPath )

指定したフォルダ内のすべてのファイルのパスを取得します。

directoryPath	文字列	ファイルを探す対象のフォルダ。
戻り値	文字列	操作が成功した場合はファイル名(配列)、失敗した場合は"FAILED"。
対応バージョン		v0.8～

 

GetSettingsFilePath

オペレーション : GetSettingsFilePath (  )

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

戻り値	文字列	このプログラム用の設定ファイルのフルパス。
対応バージョン		v0.8～

GetTemporaryFilePath

オペレーション : GetTemporaryFilePath (  )

新しい一時ファイルを作成して、そのファイルのフルパスを返します。

戻り値	文字列	作成した一時ファイルのフルパス。
対応バージョン		v0.8～

InsertLine

オペレーション : InsertLine ( filePath , lineNumber , contents )

指定したファイルの指定した行に指定した文字列を挿入します。
この機能を行うと、元の指定した行以降の文字列は1行ずつ次へ送られます。

filePath	文字列	書き出すファイルのフルパス。 フルパスは「c:\temp\settings.data」のように記述します。
lineNumber	数値	挿入するテキストの行番号。
contents	文字列	ファイルに挿入する文字列。
戻り値	文字列	書き出しが成功した場合は"SUCCESS"、失敗した場合は"FAILED"。
対応バージョン		v0.8～

LastError

プロパティ : LastError

最後に発生した、ファイル操作関係のエラーメッセージを取得または設定します。
このプロパティは実行に失敗した理由を調べるのに役立ちます。

文字列	最後に発生したエラーメッセージ。
対応バージョン		v0.8～

ReadContents

オペレーション : ReadContents ( filePath )

指定したファイルからすべての文字列を読み込みます。
この機能は1MB以下の小さなファイルに対しては高速に動作しますが、10MB以上のファイルに対しては速度が落ちます。

filePath	文字列	読み込むファイルのフルパス。 フルパスは「c:\temp\settings.data」のように記述します。
戻り値	文字列	ファイルの中のすべての文字列。
対応バージョン		v0.8～

ReadLine

オペレーション : ReadLine ( filePath , lineNumber )

指定したファイルから、指定した行の文字列を読み込みます。

filePath	文字列	読み込むファイルのフルパス。 フルパスは「c:\temp\settings.data」のように記述します。
lineNumber	数値	読み込む文字列の行番号。
戻り値	文字列	指定したファイルの指定された行の文字列。
対応バージョン		v0.8～

WriteContents

オペレーション : WriteContents ( filePath , contents )

指定したファイルへ指定した文字列を書き込みます。
ファイルの内容は新しい文字列に置き換えられます。

filePath	文字列	書き出すファイルのフルパス。 フルパスは「c:\temp\settings.data」のように記述します。
contents	文字列	指定したファイルに書き込まれる文字列。
戻り値	文字列	書き出しが成功した場合は"SUCCESS"、失敗した場合は"FAILED"。
対応バージョン		v0.8～

WriteLine

オペレーション : WriteContents ( filePath , lineNumber , contents )

指定したファイルへ指定した文字列を書き込みます。
ファイルの内容は新しい文字列に置き換えられます。

filePath	文字列	書き出すファイルのフルパス。 フルパスは「c:\temp\settings.data」のように記述します。
lineNumber	数値	上書きするテキストの行番号。
contents	文字列	指定したファイルの指定した行に書き込む文字列。
戻り値	文字列	書き出しが成功した場合は"SUCCESS"、失敗した場合は"FAILED"。
対応バージョン		v0.8～