Changeset 20831 in vbox for trunk/src/VBox/Main/idl/VirtualBox.xidl

Timestamp:

Jun 23, 2009 1:24:42 PM (15 years ago)

Author:

vboxsync

Message:

Main: refined docs on takeScreenShotSlow()

File:

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

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

@@ -10905 +10905 @@
     <method name="takeScreenShotSlow">
       <desc>
-        Takes a screen shot of the requested size and returns it as 
-        an array of bytes. This API is slow, but could be the only option for
-        scribtable languages not allowed to manipulate with addresses
+        Takes guest screen shot of the requested size and returns it as 
+        an array of bytes in uncompressed 32-bit ARGB format. 
+        This API is slow, but could be the only option to get guest screenshot 
+        for scriptable languages not allowed to manipulate with addresses
         directly.
 
@@ -10917 +10918 @@
         </result>
       </desc>
-      <param name="width" type="unsigned long" dir="in"/>
-      <param name="height" type="unsigned long" dir="in"/>
+      <param name="width" type="unsigned long" dir="in">
+        <desc>
+          Desired image width.
+        </desc>
+      </param>
+      <param name="height" type="unsigned long" dir="in">
+        <desc>
+          Desired image height.
+        </desc>
+      </param>
       <param name="screenData" type="octet" dir="out" safearray="yes">
         <desc>