summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorMaganty Rushyendra <mrushyendra@yahoo.com.sg>2020-08-04 13:05:48 +0800
committerMaganty Rushyendra <mrushyendra@yahoo.com.sg>2020-08-04 13:53:52 +0800
commit5e77eea2167db1f3c3d974ebfda54dc67b9e9519 (patch)
tree0b32efd17f1ddec20be278c040e2c2fe259064c0 /doc/classes
parent9adf6d3441d4927bdbab7bcb03cfafe42249ba90 (diff)
Updated cursor positioning description for File open()
Added more details about the cursor offsets for the different ModeFlags in the `File` class.
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/File.xml8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/classes/File.xml b/doc/classes/File.xml
index d91203d91f..af6ba17d7b 100644
--- a/doc/classes/File.xml
+++ b/doc/classes/File.xml
@@ -451,16 +451,16 @@
</members>
<constants>
<constant name="READ" value="1" enum="ModeFlags">
- Opens the file for read operations.
+ Opens the file for read operations. The cursor is positioned at the beginning of the file.
</constant>
<constant name="WRITE" value="2" enum="ModeFlags">
- Opens the file for write operations. Create it if the file does not exist and truncate if it exists.
+ Opens the file for write operations. The file is created if it does not exist, and truncated if it does.
</constant>
<constant name="READ_WRITE" value="3" enum="ModeFlags">
- Opens the file for read and write operations. Does not truncate the file.
+ Opens the file for read and write operations. Does not truncate the file. The cursor is positioned at the beginning of the file.
</constant>
<constant name="WRITE_READ" value="7" enum="ModeFlags">
- Opens the file for read and write operations. Create it if the file does not exist and truncate if it exists.
+ Opens the file for read and write operations. The file is created if it does not exist, and truncated if it does. The cursor is positioned at the beginning of the file.
</constant>
<constant name="COMPRESSION_FASTLZ" value="0" enum="CompressionMode">
Uses the [url=http://fastlz.org/]FastLZ[/url] compression method.