Difference between revisions of "(File):open"

 
m (Added information about returned error message.)
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
+
Open the file for write, read or append.
 
 
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
ok = File:open( mode )
+
ok, err = File:open( mode )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
Line 10: Line 9:
 
=== Returns ===
 
=== Returns ===
 
{{param|boolean|ok|True on success, false otherwise.}}
 
{{param|boolean|ok|True on success, false otherwise.}}
 +
{{param|string|err|The error string if an error occurred.}}
 +
=== Notes ===
 +
If you are getting the error message "Could not set write directory", try setting the save directory. This is done either with [[love.filesystem.setIdentity]] or by setting the identity field in [[love.conf]] (only available with love 0.7 or higher).
 
== See Also ==
 
== See Also ==
 
* [[parent::File]]
 
* [[parent::File]]
 +
* [[FileMode]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Open the file for write, read or append.}}
 +
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|(File):open}}

Latest revision as of 17:36, 16 January 2015

Open the file for write, read or append.

Function

Synopsis

ok, err = File:open( mode )

Arguments

FileMode mode
The mode to open the file in.

Returns

boolean ok
True on success, false otherwise.
string err
The error string if an error occurred.

Notes

If you are getting the error message "Could not set write directory", try setting the save directory. This is done either with love.filesystem.setIdentity or by setting the identity field in love.conf (only available with love 0.7 or higher).

See Also


Other Languages