VirtualBox

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


Ignore:
Timestamp:
Aug 17, 2012 1:36:01 PM (13 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
80134
Message:

Main/Guest control: Removed old API.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r42846 r42864  
    89148914
    89158915  <enum
    8916     name="ExecuteProcessFlag"
    8917     uuid="1c49b831-b2c7-4a30-97dd-999a2e2cbf90"
    8918     >
    8919     <desc>
    8920       Guest process execution flags.
    8921     </desc>
    8922 
    8923     <const name="None"                    value="0">
    8924       <desc>No flag set.</desc>
    8925     </const>
    8926     <const name="WaitForProcessStartOnly" value="1">
    8927       <desc>Only use the specified timeout value to wait for starting the guest process - the guest
    8928         process itself then uses an infinite timeout.</desc>
    8929     </const>
    8930     <const name="IgnoreOrphanedProcesses" value="2">
    8931       <desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
    8932     </const>
    8933     <const name="Hidden"                  value="4">
    8934       <desc>Do not show the started process according to the guest OS guidelines.</desc>
    8935     </const>
    8936     <const name="NoProfile"               value="8">
    8937       <desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
    8938     </const>
    8939     <const name="WaitForStdOut"           value="16">
    8940       <desc>The guest process waits until all data from stdout is read out.</desc>
    8941     </const>
    8942     <const name="WaitForStdErr"           value="32">
    8943       <desc>The guest process waits until all data from stderr is read out.</desc>
    8944     </const>
    8945   </enum>
    8946 
    8947   <enum
    8948     name="ExecuteProcessStatus"
    8949     uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
    8950     >
    8951     <desc>
    8952       Guest process execution status.
    8953     </desc>
    8954     <const name="Undefined"               value="0">
    8955       <desc>Process is in an undefined state.</desc>
    8956     </const>
    8957 
    8958     <const name="Started"                 value="1">
    8959       <desc>Process has been started.</desc>
    8960     </const>
    8961     <const name="TerminatedNormally"      value="2">
    8962       <desc>Process terminated normally.</desc>
    8963     </const>
    8964     <const name="TerminatedSignal"        value="3">
    8965       <desc>Process terminated via signal.</desc>
    8966     </const>
    8967     <const name="TerminatedAbnormally"    value="4">
    8968       <desc>Process terminated abnormally.</desc>
    8969     </const>
    8970      <const name="TimedOutKilled"         value="5">
    8971       <desc>Process timed out and was killed.</desc>
    8972     </const>
    8973     <const name="TimedOutAbnormally"      value="6">
    8974       <desc>Process timed out and was not killed successfully.</desc>
    8975     </const>
    8976     <const name="Down"                    value="7">
    8977       <desc>Service/OS is stopping, process was killed.</desc>
    8978     </const>
    8979     <const name="Error"                   value="8">
    8980       <desc>Something went wrong (error code in flags).</desc>
    8981     </const>
    8982   </enum>
    8983 
    8984   <enum
    89858916    name="FileSeekType"
    89868917    uuid="1b73f4f3-3515-4073-a506-76878d9e2541"
    … …  
    94069337  </enum>
    94079338
    9408   <enum
    9409     name="GuestDirEntryType"
    9410     uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
    9411     >
    9412     <desc>
    9413       Guest directory entry type.
    9414     </desc>
    9415     <const name="Unknown"                 value="0">
    9416       <desc>Unknown.</desc>
    9417     </const>
    9418     <const name="Directory"               value="4">
    9419       <desc>Regular file.</desc>
    9420     </const>
    9421     <const name="File"                    value="10">
    9422       <desc>Regular file.</desc>
    9423     </const>
    9424     <const name="Symlink"                 value="12">
    9425       <desc>Symbolic link.</desc>
    9426     </const>
    9427   </enum>
    9428 
    9429   <interface
    9430     name="IGuestDirEntry" extends="$unknown"
    9431     uuid="20a66efc-c2f6-4438-826f-38454c04369e"
    9432     wsmap="struct"
    9433     >
    9434     <desc>
    9435       Structure representing a directory entry on the guest OS.
    9436     </desc>
    9437     <attribute name="nodeId" type="long long" readonly="yes">
    9438       <desc>The unique identifier (within the guest's file system) of this file system object.</desc>
    9439     </attribute>
    9440     <attribute name="name" type="wstring" readonly="yes">
    9441       <desc>The filename.</desc>
    9442     </attribute>
    9443     <attribute name="type" type="GuestDirEntryType" readonly="yes">
    9444       <desc>The entry type.</desc>
    9445     </attribute>
    9446   </interface>
    9447 
    94489339  <interface
    94499340    name="IGuestSession" extends="$unknown"
    … …  
    1127511166        </desc>
    1127611167      </param>
    11277     </method>
    11278 
    11279     <method name="executeProcess">
    11280       <desc>
    11281         Executes an existing program inside the guest VM.
    11282 
    11283         <note>
    11284         Starting at VirtualBox 4.1.8 guest process execution by default is limited
    11285         to serve up to 25 guest processes at a time. If all 25 guest processes
    11286         are still active and running, starting a new guest process will result in an
    11287         appropriate error message.
    11288 
    11289         If ExecuteProcessFlag_WaitForStdOut and/or respectively
    11290         ExecuteProcessFlag_WaitForStdErr of <link to="ExecuteProcessFlag"/> is
    11291         set, the guest process will not exit until all data from the specified
    11292         stream(s) is/are read out.
    11293 
    11294         To raise or lower the guest process execution limit, either the guest property
    11295         "/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
    11296         command line by specifying "--control-procs-max-kept" needs to be modified.
    11297         A restart of the guest OS is required afterwards. To serve unlimited guest
    11298         processes, a value of "0" needs to be set (not recommended).
    11299         </note>
    11300 
    11301         <result name="VBOX_E_IPRT_ERROR">
    11302           Could not execute process.
    11303         </result>
    11304 
    11305       </desc>
    11306       <param name="execName" type="wstring" dir="in">
    11307         <desc>
    11308           Full path name of the command to execute on the guest; the
    11309           commands has to exists in the guest VM in order to be executed.
    11310         </desc>
    11311       </param>
    11312       <param name="flags" type="unsigned long" dir="in">
    11313         <desc>
    11314           <link to="ExecuteProcessFlag"/> flags.
    11315         </desc>
    11316       </param>
    11317       <param name="arguments" type="wstring" safearray="yes" dir="in">
    11318         <desc>
    11319           Array of arguments passed to the execution command.
    11320         </desc>
    11321       </param>
    11322       <param name="environment" type="wstring" safearray="yes" dir="in">
    11323         <desc>
    11324           Environment variables that can be set while the command is being
    11325           executed, in form of "NAME=VALUE"; one pair per entry. To unset a
    11326           variable just set its name ("NAME") without a value.
    11327         </desc>
    11328       </param>
    11329       <param name="userName" type="wstring" dir="in">
    11330         <desc>
    11331           User name under which the command will be executed; has to exist
    11332           and have the appropriate rights to execute programs in the VM.
    11333         </desc>
    11334       </param>
    11335       <param name="password" type="wstring" dir="in">
    11336         <desc>
    11337           Password of the user account specified.
    11338         </desc>
    11339       </param>
    11340       <param name="timeoutMS" type="unsigned long" dir="in">
    11341         <desc>
    11342           The maximum timeout value (in msec) to wait for finished program
    11343           execution. Pass 0 for an infinite timeout.
    11344         </desc>
    11345       </param>
    11346       <param name="pid" type="unsigned long" dir="out">
    11347         <desc>
    11348           The PID (process ID) of the started command for later reference.
    11349         </desc>
    11350       </param>
    11351       <param name="progress" type="IProgress" dir="return">
    11352         <desc>Progress object to track the operation completion.</desc>
    11353       </param>
    11354     </method>
    11355 
    11356     <method name="getProcessOutput">
    11357       <desc>
    11358         Retrieves output of a formerly started and running guest process.
    11359 
    11360         <note>
    11361         Starting with VirtualBox 4.1.8 this only will return output data
    11362         from stdout or stderr if flag ExecuteProcessFlag_WaitForStdOut
    11363         and/or respectively ExecuteProcessFlag_WaitForStdErr of
    11364         <link to="ExecuteProcessFlag"/> is set in the
    11365         former <link to="#executeProcess"/> call for this guest process.
    11366         </note>
    11367 
    11368         <result name="VBOX_E_IPRT_ERROR">
    11369           Could not retrieve output.
    11370         </result>
    11371 
    11372       </desc>
    11373       <param name="pid" type="unsigned long" dir="in">
    11374         <desc>
    11375           Process id returned by earlier <link to="#executeProcess"/> call.
    11376         </desc>
    11377       </param>
    11378       <param name="flags" type="unsigned long" dir="in">
    11379         <desc>
    11380           <link to="ProcessOutputFlag"/> flags.
    11381         </desc>
    11382       </param>
    11383       <param name="timeoutMS" type="unsigned long" dir="in">
    11384         <desc>
    11385           The maximum timeout value (in msec) to wait for output
    11386           data. Pass 0 for an infinite timeout.
    11387         </desc>
    11388       </param>
    11389       <param name="size" type="long long" dir="in">
    11390         <desc>
    11391           Size in bytes to read in the buffer.
    11392         </desc>
    11393       </param>
    11394       <param name="data" type="octet" safearray="yes" dir="return">
    11395         <desc>
    11396           Buffer for retrieving the actual output. A data size of 0 means end of file
    11397           if the requested size was not 0. This is the unprocessed
    11398           output data, i.e. the line ending style depends on the platform of
    11399           the system the server is running on.
    11400         </desc>
    11401       </param>
    11402     </method>
    11403 
    11404     <method name="getProcessStatus">
    11405       <desc>
    11406         Retrieves status, exit code and the exit reason of a formerly started
    11407         guest process. If a guest process exited or got terminated this function
    11408         returns its final status and removes this process from the list of
    11409         known guest processes for further retrieval.
    11410 
    11411         <result name="VBOX_E_IPRT_ERROR">
    11412           Process with specified PID was not found.
    11413         </result>
    11414 
    11415       </desc>
    11416       <param name="pid" type="unsigned long" dir="in">
    11417         <desc>
    11418           Process id returned by earlier <link to="#executeProcess"/> call.
    11419         </desc>
    11420       </param>
    11421       <param name="exitcode" type="unsigned long" dir="out">
    11422         <desc>
    11423           The exit code (if available).
    11424         </desc>
    11425       </param>
    11426       <param name="flags" type="unsigned long" dir="out">
    11427         <desc>
    11428           Additional flags of process status. Not used at the moment and
    11429           must be set to 0.
    11430         </desc>
    11431       </param>
    11432       <param name="reason" type="ExecuteProcessStatus" dir="return">
    11433         <desc>
    11434           The current process status.
    11435         </desc>
    11436       </param>
    11437     </method>
    11438 
    11439     <method name="copyFromGuest">
    11440       <desc>
    11441         Copies files/directories from guest to the host.
    11442 
    11443         <result name="VBOX_E_IPRT_ERROR">
    11444           Error while copying.
    11445         </result>
    11446 
    11447       </desc>
    11448       <param name="source" type="wstring" dir="in">
    11449         <desc>
    11450           Source file on the guest to copy.
    11451         </desc>
    11452       </param>
    11453       <param name="dest" type="wstring" dir="in">
    11454         <desc>
    11455           Destination path on the host.
    11456         </desc>
    11457       </param>
    11458       <param name="userName" type="wstring" dir="in">
    11459         <desc>
    11460           User name under which the copy command will be executed; the
    11461           user has to exist and have the appropriate rights to read from
    11462           the source path.
    11463         </desc>
    11464       </param>
    11465       <param name="password" type="wstring" dir="in">
    11466         <desc>
    11467           Password of the user account specified.
    11468         </desc>
    11469       </param>
    11470       <param name="flags" type="unsigned long" dir="in">
    11471         <desc>
    11472           <link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
    11473         </desc>
    11474       </param>
    11475       <param name="progress" type="IProgress" dir="return">
    11476         <desc>Progress object to track the operation completion.</desc>
    11477       </param>
    11478     </method>
    11479 
    11480     <method name="copyToGuest">
    11481       <desc>
    11482         Copies files/directories from host to the guest.
    11483 
    11484         <result name="VBOX_E_IPRT_ERROR">
    11485           Error while copying.
    11486         </result>
    11487 
    11488       </desc>
    11489       <param name="source" type="wstring" dir="in">
    11490         <desc>
    11491           Source file on the host to copy.
    11492         </desc>
    11493       </param>
    11494       <param name="dest" type="wstring" dir="in">
    11495         <desc>
    11496           Destination path on the guest.
    11497         </desc>
    11498       </param>
    11499       <param name="userName" type="wstring" dir="in">
    11500         <desc>
    11501           User name under which the copy command will be executed; the
    11502           user has to exist and have the appropriate rights to write to
    11503           the destination path.
    11504         </desc>
    11505       </param>
    11506       <param name="password" type="wstring" dir="in">
    11507         <desc>
    11508           Password of the user account specified.
    11509         </desc>
    11510       </param>
    11511       <param name="flags" type="unsigned long" dir="in">
    11512         <desc>
    11513           <link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
    11514         </desc>
    11515       </param>
    11516       <param name="progress" type="IProgress" dir="return">
    11517         <desc>Progress object to track the operation completion.</desc>
    11518       </param>
    11519     </method>
    11520 
    11521     <method name="directoryClose">
    11522       <desc>
    11523         Closes a formerly opened guest directory.
    11524 
    11525         <result name="VBOX_E_IPRT_ERROR">
    11526           Error while closing directory.
    11527         </result>
    11528 
    11529       </desc>
    11530       <param name="handle" type="unsigned long" dir="in">
    11531         <desc>
    11532           Handle of opened directory to close.
    11533         </desc>
    11534       </param>
    11535     </method>
    11536 
    11537     <method name="directoryCreate">
    11538       <desc>
    11539         Creates a directory on the guest.
    11540 
    11541         <result name="VBOX_E_IPRT_ERROR">
    11542           Error while creating directory.
    11543         </result>
    11544 
    11545       </desc>
    11546       <param name="directory" type="wstring" dir="in">
    11547         <desc>
    11548           Directory to create.
    11549         </desc>
    11550       </param>
    11551       <param name="userName" type="wstring" dir="in">
    11552         <desc>
    11553           User name under which the directory creation will be executed; the
    11554           user has to exist and have the appropriate rights to create the
    11555           desired directory.
    11556         </desc>
    11557       </param>
    11558       <param name="password" type="wstring" dir="in">
    11559         <desc>
    11560           Password of the user account specified.
    11561         </desc>
    11562       </param>
    11563       <param name="mode" type="unsigned long" dir="in">
    11564         <desc>
    11565           File mode.
    11566         </desc>
    11567       </param>
    11568       <param name="flags" type="unsigned long" dir="in">
    11569         <desc>
    11570           <link to="DirectoryCreateFlag"/> flags.
    11571         </desc>
    11572       </param>
    11573     </method>
    11574 
    11575     <method name="directoryOpen">
    11576       <desc>
    11577         Opens a directory on the guest.
    11578 
    11579         <result name="VBOX_E_IPRT_ERROR">
    11580           Error while opening / reading directory.
    11581         </result>
    11582 
    11583       </desc>
    11584       <param name="directory" type="wstring" dir="in">
    11585         <desc>
    11586           Directory to read.
    11587         </desc>
    11588       </param>
    11589       <param name="filter" type="wstring" dir="in">
    11590         <desc>
    11591           Directory filter (DOS style wildcards). Set to empty
    11592           string if no filter required.
    11593         </desc>
    11594       </param>
    11595       <param name="flags" type="unsigned long" dir="in">
    11596         <desc>
    11597           <link to="DirectoryOpenFlag"/> flags.
    11598         </desc>
    11599       </param>
    11600       <param name="userName" type="wstring" dir="in">
    11601         <desc>
    11602           User name under which the directory reading will be performed; the
    11603           user has to exist and have the appropriate rights to access / read the
    11604           desired directory.
    11605         </desc>
    11606       </param>
    11607       <param name="password" type="wstring" dir="in">
    11608         <desc>
    11609           Password of the user account specified.
    11610         </desc>
    11611       </param>
    11612       <param name="handle" type="unsigned long" dir="return">
    11613         <desc>
    11614           Handle of opened directory returned by openDirectory.
    11615         </desc>
    11616       </param>
    11617     </method>
    11618 
    11619     <method name="directoryRead">
    11620       <desc>
    11621         Reads the next directory entry of an opened guest directory.
    11622 
    11623         <result name="E_ABORT">
    11624           When the end of the directory has been reached.
    11625         </result>
    11626 
    11627         <result name="VBOX_E_IPRT_ERROR">
    11628           Error while opening / reading directory.
    11629         </result>
    11630 
    11631       </desc>
    11632       <param name="handle" type="unsigned long" dir="in">
    11633         <desc>
    11634           Handle of opened directory returned by openDirectory.
    11635         </desc>
    11636       </param>
    11637       <param name="entry" type="IGuestDirEntry" dir="return">
    11638         <desc>
    11639           Information about next directory entry on success.
    11640         </desc>
    11641       </param>
    11642     </method>
    11643 
    11644     <method name="fileExists">
    11645       <desc>
    11646         Checks if the specified file name exists and is a regular file.
    11647 
    11648         If the file name ends with a slash or backslash, the function assumes
    11649         it's a directory and will check if the specified directory exists and
    11650         is a regular directory.
    11651 
    11652         <result name="VBOX_E_IPRT_ERROR">
    11653           Error while looking up information.
    11654         </result>
    11655 
    11656       </desc>
    11657       <param name="file" type="wstring" dir="in">
    11658         <desc>
    11659           Full path of file to check.
    11660         </desc>
    11661       </param>
    11662       <param name="userName" type="wstring" dir="in">
    11663         <desc>
    11664           User name under which the lookup will be performed; the
    11665           user has to exist and have the appropriate rights to access / read the
    11666           desired directory.
    11667         </desc>
    11668       </param>
    11669       <param name="password" type="wstring" dir="in">
    11670         <desc>
    11671           Password of the user account specified.
    11672         </desc>
    11673       </param>
    11674       <param name="exists" type="boolean" dir="return">
    11675         <desc>
    11676           True if it's a regular file, false if it isn't (or doesn't exist).
    11677         </desc>
    11678       </param>
    11679     </method>
    11680 
    11681     <method name="fileQuerySize">
    11682       <desc>
    11683         Queries the size of a file, given the path to it.
    11684 
    11685         <result name="VBOX_E_IPRT_ERROR">
    11686           Error while looking up information.
    11687         </result>
    11688 
    11689       </desc>
    11690       <param name="file" type="wstring" dir="in">
    11691         <desc>
    11692           Full path of file to query file size for.
    11693         </desc>
    11694       </param>
    11695       <param name="userName" type="wstring" dir="in">
    11696         <desc>
    11697           User name under which the lookup will be performed; the
    11698           user has to exist and have the appropriate rights to access / read the
    11699           desired directory.
    11700         </desc>
    11701       </param>
    11702       <param name="password" type="wstring" dir="in">
    11703         <desc>
    11704           Password of the user account specified.
    11705         </desc>
    11706       </param>
    11707       <param name="size" type="long long" dir="return">
    11708         <desc>
    11709           Size (in bytes) of file specified.
    11710         </desc>
    11711       </param>
    11712     </method>
    11713 
    11714     <method name="setProcessInput">
    11715       <desc>
    11716         Sends input into a formerly started process.
    11717 
    11718         <result name="VBOX_E_IPRT_ERROR">
    11719           Could not send input.
    11720         </result>
    11721 
    11722       </desc>
    11723       <param name="pid" type="unsigned long" dir="in">
    11724         <desc>
    11725           Process id returned by earlier <link to="#executeProcess"/> call.
    11726         </desc>
    11727       </param>
    11728       <param name="flags" type="unsigned long" dir="in">
    11729         <desc>
    11730           <link to="ProcessInputFlag"/> flags.
    11731         </desc>
    11732       </param>
    11733       <param name="timeoutMS" type="unsigned long" dir="in">
    11734         <desc>
    11735           The maximum timeout value (in msec) to wait for getting the
    11736           data transfered to the guest. Pass 0 for an infinite timeout.
    11737         </desc>
    11738       </param>
    11739       <param name="data" type="octet" dir="in" safearray="yes">
    11740         <desc>
    11741           Buffer of input data to send to the started process to.
    11742         </desc>
    11743       </param>
    11744       <param name="written" type="unsigned long" dir="return">
    11745         <desc>
    11746           Number of bytes written.
    11747         </desc>
    11748       </param>
    11749     </method>
     11168    </method> 
    1175011169
    1175111170    <method name="updateGuestAdditions">
Note: See TracChangeset for help on using the changeset viewer.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette