Changeset 99782 in vbox

Timestamp:

May 12, 2023 2:53:20 PM (21 months ago)

Author:

vboxsync

Message:

Guest Control/Main: Marked IGuestSession::waitFor() and IGuestProcess::waitFor() as being deprecated; we have the waitForArray() methods for that (don't use flags as parameters). bugref:9320

Location:

trunk

Files:

• doc/manual/en_US/SDKRef.xml (modified) (1 diff)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (2 diffs)
• src/VBox/Main/src-client/GuestProcessImpl.cpp (modified) (1 diff)
• src/VBox/Main/src-client/GuestSessionImpl.cpp (modified) (1 diff)

trunk/doc/manual/en_US/SDKRef.xml

@@ -4176 +4176 @@
           See <link linkend="IGuestSession__fsQueryInfo">IGuestSession::fsQueryInfo</link> and
           <link linkend="IGuestSession__fsQueryFreeSpace">IGuestSession::fsQueryFreeSpace</link> for more information.</para>
+        </listitem>
+
+        <listitem><para>The APIs <link linkend="IGuestSession__waitFor">IGuestSession::waitFor</link> and
+          <link linkend="IGuestProcess__waitFor">IGuestProcess::waitFor</link> are now marked
+          as being deprecated. Use <link linkend="IGuestSession__waitForArray">IGuestSession::waitForArray</link>
+          and <link linkend="IGuestProcess__waitForArray">IGuestProcess::waitForArray</link> instead.</para>
         </listitem>
 

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

@@ -16202 +16202 @@
       <desc>
         Waits for one or more events to happen.
+        <note>
+          Deprecated and will be removed. Use <link to="IGuestSession::waitForArray"/> instead.
+        </note>
       </desc>
       <param name="waitFor" type="unsigned long" dir="in">
@@ -16304 +16307 @@
       <desc>
         Waits for one or more events to happen.
+        <note>
+          Deprecated and will be removed. Use <link to="IProcess::waitForArray"/> instead.
+        </note>
       </desc>
       <param name="waitFor" type="unsigned long" dir="in">

trunk/src/VBox/Main/src-client/GuestProcessImpl.cpp

@@ -2146 +2146 @@
 }
 
+/* Deprecated; use GuestProcess::waitForArray() instead. */
 HRESULT GuestProcess::waitFor(ULONG aWaitFor, ULONG aTimeoutMS, ProcessWaitResult_T *aReason)
 {

trunk/src/VBox/Main/src-client/GuestSessionImpl.cpp

@@ -5252 +5252 @@
 }
 
+/* Deprecated; use GuestSession::waitForArray() instead. */
 HRESULT GuestSession::waitFor(ULONG aWaitFor, ULONG aTimeoutMS, GuestSessionWaitResult_T *aReason)
 {