FileWriteString 関数
この関数は、開いているファイル (bin、csv、txt形式) のファイルポインタの現在位置から文字列を書き込みます。
書き込むファイルの指定は、FileOpen関数によって取得されるファイルハンドルを使って行ないます。
csv形式と txt形式に書き込む場合、文字列の最後に改行文字 “\r\n” が追加されます。
データ型と構成・戻り値
uint FileWriteString(①, ②, ③);戻り値は、処理が成功した場合は、書き込んだバイト数を返します。エラーの場合は 0を返します。
発生するエラーについては、GetLastError関数で取得することができます。
引数 [3]
FileWriteString関数は 3個の引数で構成されます。
| 番 号 | 引数名 | データ型 | 単位 | 初期値 | 説明 |
|---|---|---|---|---|---|
| ① | file_handle | int | － | － | FileOpen関数によって取得されるファイルハンドル。 |
| ② | value | const string | － | － | 書き込む文字列。 |
| ③ | length | int | － | 0 | 書き込む文字数 (文字列の長さ)。binファイルのみ必要です。文字列の長さより大きいサイズを指定した場合、文字列は適切な数の「0」で埋められます。csv および txt形式のファイルの場合、このパラメータは無視され、文字列全体が書き込まれます。 |
使用例
FileWriteString関数による binファイルへの文字列の書き込み
FileWriteString関数を使って指定した binファイルに文字列「testテスト」を書き込みます。
書き込むファイルは FileOpen関数で選択します。もし、ファイルが存在しない場合は新規にファイルが作成されます。
書き込んだファイルの場所については FileOpen関数のページで確認してください。もし結果が異なる場合は、書き込みをした「test.bin」ファイルを削除して再度実行してください。
コード
// FileWriteString関数による binファイルへの文字列の書き込み
#property strict
void OnInit() {
string filename = "test.bin"; // ファイル名
int handle; // ファイルハンドル
handle = FileOpen(filename, FILE_READ | FILE_WRITE | FILE_BIN );
uint b = FileWriteString(handle, "testテスト", 20);
FileSeek(handle, 0, SEEK_SET); // ファイルポインタの位置を先頭に移動
Print("ファイルの内容：", FileReadString(handle, 20));
Print("書き込んだバイト数：", b);
FileClose(handle);
}コードをコンパイルして実行する方法はこちらを参考にしてください。(デモ口座でお試しください)
結果
