Changeset 36721 in vbox

Timestamp:

Apr 18, 2011 6:05:05 PM (14 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

71238

Message:

Main/idl: clarify the availability of IDisplay::takeScreenShot

File:

• trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (1 diff)

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

@@ -11581 +11581 @@
         A pixel consists of 4 bytes in order: B, G, R, 0.
 
-        <note>This API can be used only by the COM/XPCOM C++ API as it
-            requires pointer support. Use <link to="#takeScreenShotToArray" />
-            with other language bindings.
+        <note>This API can be used only locally by a VM process through the
+            COM/XPCOM C++ API as it requires pointer support. It is not
+            available for scripting langages, Java or any webservice clients.
+            Unless you are writing a new VM frontend use
+            <link to="#takeScreenShotToArray" />.
         </note>