Difference between revisions of "love.filesystem.newFile"

(added apparent restriction on ':' in filenames on at least Linux and OS X)
m (Add note about the lack of error messages.)
Line 8: Line 8:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|string|filename|The filename of the file. (Note that ':' may not occur in a filename.)}}
+
{{param|string|filename|The filename of the file.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|File|file|The new File object.}}
 
{{param|File|file|The new File object.}}
 +
=== Notes ===
 +
Please note that this function will not return any error message (e.g. if you use an invalid filename) because it just creates the File Object. You can still check if the file is valid by using [[(File):open|File:open]] which returns a boolean and an error message if something goes wrong while opening the file.
  
 
== Function ==
 
== Function ==

Revision as of 17:58, 16 January 2015

Creates a new File object. It needs to be opened before it can be accessed.

Function

Synopsis

file = love.filesystem.newFile( filename )

Arguments

string filename
The filename of the file.

Returns

File file
The new File object.

Notes

Please note that this function will not return any error message (e.g. if you use an invalid filename) because it just creates the File Object. You can still check if the file is valid by using File:open which returns a boolean and an error message if something goes wrong while opening the file.

Function

Available since LÖVE 0.9.0
This variant is not supported in earlier versions.

Creates a File object and opens it for reading, writing, or appending.

Synopsis

file, errorstr = love.filesystem.newFile( 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.

Examples

Open a file and read everything

file = love.filesystem.newFile("data.txt")
file:open("r")
data = file:read()

See Also


Other Languages