Function Reference

FileWrite

Append a line of text to the end of a previously opened text file.

FileWrite ( filehandle or "filename", "line" )

 

Parameters

filehandle The handle of a file, as returned by a previous call to FileOpen. Alternatively, you may use a string filename as the first parameter.
line The line of text to write to the text file. The line is written as is - no @CR or @LF characters are added.

 

Return Value

Success: Returns 1.
Failure: Returns 0 if file not opened in writemode, file is read only, or file cannot otherwise be written to.

 

Remarks

The text file must be opened in write mode or the FileWrite command will fail.

If a filename is given rather than a file handle, the file will be opened and closed during the function call. For parsing large text files this will be much slower than using filehandles. However, filename will be created if it does not already exist.

Note: Do not mix filehandles and filenames, i.e., don't FileOpen a file and then use a filename in this function. Either use filehandles or filenames in your routines, not both.

When writing text AutoIt will write using ANSI by default. To write in Unicode mode the file must be opened with FileOpen() and the relevant flags.

If the line is a binary type variant (and not text) it will be written to the file byte by byte. Binary operation can also be forced by using Fileopen with the binary flag.

 

Related

FileClose, FileOpen, FileRead, FileReadLine, FileWriteLine, Binary

 

Example


$file = FileOpen("test.txt", 1)

; Check if file opened for writing OK
If $file = -1 Then
    MsgBox(0, "Error", "Unable to open file.")
    Exit
EndIf

FileWrite($file, "Line1")
FileWrite($file, "Still Line1" & @CRLF)
FileWrite($file, "Line2")

FileClose($file)