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

Timestamp:

Nov 1, 2013 8:55:08 AM (11 years ago)

Author:

vboxsync

Message:

SDK documentation: Clarification for IGuest::CreateSession().

File:

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

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

@@ -12211 +12211 @@
     <method name="createSession">
       <desc>
-        Creates a new guest session for controlling the guest.
+        Creates a new guest session for controlling the guest. The new session
+        will be started asynchronously, meaning on return of this function it is
+        not guaranteed that the guest session is in a started and/or usable state.
+        To wait for successful startup, use the <link to="IGuestSession::waitFor"/>
+        call.
 
         A guest session represents one impersonated user account on the guest, so