VirtualBox

Changeset 8836

Show
Ignore:
Timestamp:
05/15/08 11:19:00 (3 months ago)
Author:
vboxsync
Message:

Main: API doc fixes

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r8439 r8836  
    18751875    <method name="openRemoteSession"> 
    18761876      <desc> 
    1877         Opens a new remote session with the given virtual 
    1878         machine. 
     1877        Opens a new remote session with the given virtual machine. 
    18791878 
    18801879        Opening a remote session causes the VirtualBox server to start a new 
    …… 
    18841883        session context, not all VM settings are available for modification. 
    18851884 
    1886         This operation can take some time, so the progress object 
    1887         is returned to let the caller be informed when the session is 
    1888         actually open. Until then, the remote session object remains in 
    1889         the closed state and accessing the machine or its console through 
    1890         it is invalid. 
     1885        This operation can take some time (a new VM is started in a new process, 
     1886        for which memory and other resources need to be set up, which can take 
     1887        a few seconds). Because of this, a progress object is returned to allow the 
     1888        caller to wait for this asynchronous operation to be completed. Until then, 
     1889        the remote session object remains in the closed state and accessing the 
     1890        machine or its console through it is invalid. It is recommended to use 
     1891        <link to="IProgress::waitForCompletion" /> or similar calls to wait for 
     1892        completion. 
    18911893 
    18921894        Currently supported session types (values of the @a type 
    …… 
    40894091        If the machine is in the <link to="MachineState::Saved"/> state, 
    40904092        it will continue its execution the point where the state has 
    4091         beem saved. 
     4093        been saved. 
     4094 
     4095        <note> 
     4096            Unless you are trying to write a new VirtualBox front-end that 
     4097            performs direct machine execution (like the VirtualBox or VBoxSDL 
     4098            front-ends), don't call <link to="IConsole::powerUp"/> in a direct 
     4099            session opened by <link to="IVirtualBox::openSession"/> and use this 
     4100            session only to change virtual machine settings. If you simply want to 
     4101            start virtual machine execution using one of the existing front-ends 
     4102            (for example the VirtualBox GUI or headless server), simply use 
     4103            <link to="IVirtualBox::openRemoteSession"/>; these front-ends 
     4104            will power up the machine automatically for you. 
     4105        </note> 
    40924106 
    40934107        <see>#saveState</see> 
    …… 
    41344148      <desc> 
    41354149        Saves the current execution state of a running virtual machine 
    4136         and stops its executiuon. 
     4150        and stops its execution. 
    41374151 
    41384152        After this operation completes, the machine will go to the 
    …… 
    97649778        Unless you are trying to write a new VirtualBox front-end that 
    97659779        performs direct machine execution (like the VirtualBox or VBoxSDL 
    9766         frontends), don't call <link to="IConsole::powerUp"/> in a direct 
     9780        front-ends), don't call <link to="IConsole::powerUp"/> in a direct 
    97679781        session opened by <link to="IVirtualBox::openSession"/> and use this 
    97689782        session only to change virtual machine settings. If you simply want to 
    9769         start virtual machine execution using one of the existing frontends 
    9770         (for example the VirtualBox GUI frontend), use 
    9771         <link to="IVirtualBox::openRemoteSession"/>. In the latter case, on 
    9772         sucess, the machine will be powered up for you by the front-end so you 
    9773         don't need to call <link to="IConsole::powerUp"/> too. 
     9783        start virtual machine execution using one of the existing front-ends 
     9784        (for example the VirtualBox GUI or headless server), simply use 
     9785        <link to="IVirtualBox::openRemoteSession"/>; these front-ends 
     9786        will power up the machine automatically for you. 
    97749787      </note> 
    97759788    </desc> 

© 2008 Sun Microsystems, Inc.
Contact – Privacy policy