Writes one or more strings to a given file, starting at the current read/write position. Advances the position over the number of bytes that were written.

Important

It is important to remember to close a file after you've finished all your operations on it, especially if you've been writing to the file. If you don't close a file and your resource crashes, all changes to the file may be lost.

OOP Syntax Help! I don't understand this!

• Method:file:write(...)

Syntax

​int|false fileWrite ( ​file theFile, ​string string1, [ ​string string2 = nil ] )

Required arguments

• theFile: A handle to the file you wish to write to. The file must have been opened with write access, i.e. the file handle must be a result of fileCreate or fileOpen with the readonly parameter set to false.
• string1: The string to write.

Optional arguments

Note: when using optional arguments, you might need to supply all arguments before the one you wish to use.

• string2 (default: nil): You can provide any number of additional strings to write after string1. These will be written in the order in which they are specified.

Returns

Returns the number of bytes successfully written to the file, returns false if invalid arguments were specified.

• int|false: result

Code Examples

Example 1 Example 2 (OOP)

shared

This example creates a text file and writes a string to it.

local fileHandle = fileCreate("test.txt") -- attempt to create a new file
if fileHandle then -- check if the creation succeeded
    fileWrite(fileHandle, "This is a test file!") -- write a text line
    fileClose(fileHandle) -- close the file once you're done with it
end

shared

OOP Required

This example creates a text file and writes a string to it.

local fileHandle = File.new("test.txt") -- attempt to create a new file
if (fileHandle) then -- check if the creation succeeded
    fileHandle:write("This is a test file!") -- write a text line
    fileHandle:close() -- close the file once you're done with it
end

See Also

File Functions

• fileClose
• fileCopy
• fileCreate
• fileDelete
• fileExists
• fileFlush
• fileGetContents
• fileGetHashNew
• fileGetPath
• fileGetPos
• fileGetSize
• fileIsEOF
• fileOpen
• fileRead
• fileRename
• fileSetPos
• fileWrite

File Elements

• file

Reference

• Scripting Functions