Changeset 79301 in vbox

Timestamp:

Jun 24, 2019 10:38:53 AM (5 years ago)

Author:

vboxsync

Message:

Main/GuestFileImpl.cpp: More doc updates wrt file offsets, reading and writing. bugref:9320

File:

• trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (5 diffs)

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -14229 +14229 @@
         Reads data from this file.
 
-        <result name="E_NOTIMPL">
-          The method is not implemented yet.
-        </result>
+        The file current position (<link to="IFile::offset"/>) is updated on success.
       </desc>
       <param name="toRead" type="unsigned long" dir="in">
@@ -14251 +14249 @@
         Reads data from an offset of this file.
 
-        <result name="E_NOTIMPL">
-          The method is not implemented yet.
-        </result>
+        The file current position (<link to="IFile::offset"/>) is updated on success.
       </desc>
       <param name="offset" type="long long" dir="in">
@@ -14316 +14312 @@
       <desc>
         Changes the file size.
-
-        <result name="E_NOTIMPL">
-          The method is not implemented yet.
-        </result>
       </desc>
       <param name="size" type="long long" dir="in">
@@ -14329 +14321 @@
       <desc>
         Writes bytes to this file.
+
+        The file current position (<link to="IFile::offset"/>) is updated on success.
       </desc>
       <param name="data" type="octet" dir="in" safearray="yes">
@@ -14351 +14345 @@
         Writes bytes at a certain offset to this file.
 
-        <result name="E_NOTIMPL">
-          The method is not implemented yet.
-        </result>
+        The file current position (<link to="IFile::offset"/>) is updated on success.
       </desc>
       <param name="offset" type="long long" dir="in">
-        <desc>Offset in bytes to start writing.</desc>
+        <desc>Offset in bytes to start writing.  If the file was opened with the
+        <link to="IFile::accessMode"/> set to <link to="FileAccessMode_AppendOnly"/>
+        or <link to="FileAccessMode_AppendRead"/>, the offset is ignored and the
+        write always goes to the end of the file.</desc>
       </param>
       <param name="data" type="octet" dir="in" safearray="yes">