Changeset 47835 in vbox

Timestamp:

Aug 19, 2013 9:13:49 AM (11 years ago)

Author:

vboxsync

Message:

Main: Documentation.

File:

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

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

@@ -10621 +10621 @@
       </param>
       <param name="openMode" type="wstring" dir="in">
-        <desc>The file open mode.</desc>
+        <desc>The file opening mode. This describes the wanted access to a file, whereas
+          the parameter must be one of the following:
+          <ul>
+            <li><b>r</b>Opens a file for reading.</li>
+            <li><b>r+</b>Opens a file for reading and writing.</li>
+            <li><b>w</b>Opens a file for writing.</li>
+            <li><b>w+</b>Opens a file for writing and reading.</li>
+          </ul>
+        </desc>
       </param>
       <param name="disposition" type="wstring" dir="in">
-        <desc>The file disposition.</desc>
+        <desc>The file disposition. This describes the action to take in case a
+          file exists or does not exist, whereas the parameter must be one of the
+          following:
+          <ul>
+            <li><b>ca</b>Creates a new file, always. Overwrites an existing file.</li>
+            <li><b>ce</b>Creates a new file if it does not exist. Fail if exist.</li>
+            <li><b>oc</b>Opens and existing file or create it if it does not exist.</li>
+            <li><b>oe</b>Opens an existing file or fail if it does not exist.</li>
+            <li><b>ot</b>Opens and truncate an existing file or fail if it does not exist.</li>
+          </ul>
+        </desc>
       </param>
       <param name="creationMode" type="unsigned long" dir="in">
-        <desc>The file creation mode.</desc>
+        <desc>The mode to create the file with. Must be a three-digit octal number which
+          represents the access rights for the file.</desc>
       </param>
       <param name="file" type="IGuestFile" dir="return">
@@ -10650 +10669 @@
       </param>
       <param name="openMode" type="wstring" dir="in">
-        <desc>The file open mode.</desc>
+        <desc>The file opening mode. This describes the wanted access to a file, whereas
+          the parameter must be one of the following:
+          <ul>
+            <li><b>r</b>Opens a file for reading.</li>
+            <li><b>r+</b>Opens a file for reading and writing.</li>
+            <li><b>w</b>Opens a file for writing.</li>
+            <li><b>w+</b>Opens a file for writing and reading.</li>
+          </ul>
+        </desc>
       </param>
       <param name="disposition" type="wstring" dir="in">
-        <desc>The file disposition.</desc>
+        <desc>The file disposition. This describes the action to take in case a
+          file exists or does not exist, whereas the parameter must be one of the
+          following:
+          <ul>
+            <li><b>ca</b>Creates a new file, always. Overwrites an existing file.</li>
+            <li><b>ce</b>Creates a new file if it does not exist. Fail if exist.</li>
+            <li><b>oc</b>Opens and existing file or create it if it does not exist.</li>
+            <li><b>oe</b>Opens an existing file or fail if it does not exist.</li>
+            <li><b>ot</b>Opens and truncate an existing file or fail if it does not exist.</li>
+          </ul>
+        </desc>
       </param>
       <param name="sharingMode" type="wstring" dir="in">
-        <desc>The file sharing mode on the guest.</desc>
+        <desc>The file sharing mode on the guest. This parameter
+          is not implemented yet.</desc>
       </param>
       <param name="creationMode" type="unsigned long" dir="in">
-        <desc>The file creation mode.</desc>
+        <desc>The mode to create the file with. Must be a three-digit octal number which
+          represents the access rights for the file.</desc>
       </param>
       <param name="offset" type="long long" dir="in">
-        <desc>The initial read/write offset.</desc>
+        <desc>The initial read/write offset (in bytes).</desc>
       </param>
       <param name="file" type="IGuestFile" dir="return">
@@ -11264 +11303 @@
   <interface
     name="IFile" extends="$unknown"
-    uuid="ceb895d7-8b2d-4a39-8f7c-7d2270f341d5"
+    uuid="984a8bb5-ec58-4685-ab5e-7b46112b6b56"
     wsmap="managed"
     >
@@ -11275 +11314 @@
       </desc>
     </attribute>
-    <attribute name="disposition" type="unsigned long" readonly="yes">
+    <attribute name="disposition" type="wstring" readonly="yes">
       <desc>
         The disposition mode.
@@ -11295 +11334 @@
       </desc>
     </attribute>
-    <attribute name="openMode" type="unsigned long" readonly="yes">
+    <attribute name="openMode" type="wstring" readonly="yes">
       <desc>
         The open mode.