Difference between revisions of "love.filesystem.openFile"

m
m
 
Line 14: Line 14:
 
{{param|File|file|The new File object, or nil if an error occurred.}}
 
{{param|File|file|The new File object, or nil if an error occurred.}}
 
{{param|string|errorstr|The error string if an error occurred.}}
 
{{param|string|errorstr|The error string if an error occurred.}}
 +
 +
== Notes ==
 +
[[love.filesystem.read]], [[love.filesystem.write]], and [[love.filesystem.append]] are more convenient functions to use in situations where a file is operated on once rather than multiple times.
  
 
== Examples ==
 
== Examples ==

Latest revision as of 02:13, 11 November 2022

Available since LÖVE 12.0
This function replaces love.filesystem.newFile.


Opens a new File object, which represents an existing or new file on disk.

Function

Synopsis

file, errorstr = love.filesystem.openFile( filename, mode )

Arguments

string filename
The filename of the file.
FileMode mode
The mode to open the file in.

Returns

File file
The new File object, or nil if an error occurred.
string errorstr
The error string if an error occurred.

Notes

love.filesystem.read, love.filesystem.write, and love.filesystem.append are more convenient functions to use in situations where a file is operated on once rather than multiple times.

Examples

Open a file and read everything

file = love.filesystem.openFile("data.txt", "r")
data = file:read()
file:close()
-- use the data ...

See Also

Other Languages