Changeset 99780 in vbox for trunk/src/VBox/Main/idl

Timestamp:

May 12, 2023 1:56:04 PM (22 months ago)

Author:

vboxsync

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

157385

Message:

Guest Control/Main: Documented current limitations of the ProcessWaitForFlag_Std[In|Out|Err] flags. bugref:9320

File:

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

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

@@ -13860 +13860 @@
     </const>
     <const name="StdIn"                 value="4">
-      <desc>Wait for stdin becoming available.</desc>
+      <desc>Wait for stdin becoming available.
+        <para>Not implemented; will currently return <link to="ProcessWaitResult_WaitFlagNotSupported"/>.
+          Writing process input can be performed via <link to="IProcess::write"/> or waiting for the
+          <link to="IGuestProcessInputNotifyEvent"/> event.
+        </para>
+      </desc>
     </const>
     <const name="StdOut"                value="8">
-      <desc>Wait for data becoming available on stdout.</desc>
+      <desc>Wait for data becoming available on stdout.
+        <para>Not implemented; will currently return <link to="ProcessWaitResult_WaitFlagNotSupported"/>.
+          Reading process stdout output can be performed via <link to="IProcess::read"/> or waiting for the
+          <link to="IGuestProcessOutputEvent"/> event.
+        </para>
+      </desc>
     </const>
     <const name="StdErr"                value="16">
-      <desc>Wait for data becoming available on stderr.</desc>
+      <desc>Wait for data becoming available on stderr.
+        <para>Not implemented; will currently return <link to="ProcessWaitResult_WaitFlagNotSupported"/>.
+          Reading process stderr output can be performed via <link to="IProcess::read"/> or waiting for the
+          <link to="IGuestProcessOutputEvent"/> event.
+        </para>
+      </desc>
     </const>
   </enum>