VirtualBox

儲存庫 vbox 的更動 42805


忽略:
時間撮記:
2012-8-14 下午01:24:14 (12 年 以前)
作者:
vboxsync
訊息:

Guest Control 2.0: Documentation.

檔案:
修改 1 筆資料

圖例:

未更動
新增
刪除

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

    r42754 r42805  
    52335233              </param>
    52345234              <param name="force" type="boolean" dir="in">
    5235               <desc>Allows to force unmount of a medium which is locked by 
     5235              <desc>Allows to force unmount of a medium which is locked by
    52365236              the device slot in the given port medium is attached to.</desc>
    52375237              </param>
    … …  
    89578957    </const>
    89588958  </enum>
    8959  
     8959
    89608960  <enum
    89618961    name="FileSeekType"
    … …  
    89638963    >
    89648964    <desc>
    8965       TODO
     8965      File seeking types.
    89668966    </desc>
    89678967
    89688968    <const name="Set"                     value="0">
    8969       <desc>TODO</desc>
    8970     </const>   
     8969      <desc>Seek from the start of the file.</desc>
     8970    </const>
    89718971    <const name="Current"                 value="1">
    8972       <desc>TODO</desc>
    8973     </const>   
     8972      <desc>Seek from the current file position.</desc>
     8973    </const>
    89748974  </enum>
    89758975
    … …  
    90049004    </const>
    90059005  </enum>
    9006  
     9006
    90079007  <enum
    90089008    name="ProcessWaitForFlag"
    … …  
    90109010    >
    90119011    <desc>
    9012       TODO
     9012      Process waiting flags. Multiple flags can be combined.
    90139013    </desc>
    90149014
    90159015    <const name="None"                    value="0">
    9016       <desc>TODO</desc>
     9016      <desc>No waiting flags specified. Do not use this.</desc>
    90179017    </const>
    90189018    <const name="Start"                   value="1">
    9019       <desc>TODO</desc>
     9019      <desc>Wait for the process being started.</desc>
    90209020    </const>
    90219021    <const name="Terminate"               value="2">
    9022       <desc>TODO</desc>
    9023     </const>       
     9022      <desc>Wait for the process being terminated.</desc>
     9023    </const>
    90249024    <const name="StdIn"                   value="4">
    9025       <desc>TODO</desc>
    9026     </const>   
     9025      <desc>Wait for stdin becoming available.</desc>
     9026    </const>
    90279027    <const name="StdOut"                  value="8">
    9028       <desc>TODO</desc>
    9029     </const>   
     9028      <desc>Wait for data becoming available on stdout.</desc>
     9029    </const>
    90309030    <const name="StdErr"                  value="16">
    9031       <desc>TODO</desc>
    9032     </const>           
     9031      <desc>Wait for data becoming available on stderr.</desc>
     9032    </const>
    90339033  </enum>
    9034  
     9034
    90359035  <enum
    90369036    name="ProcessWaitResult"
    … …  
    90389038    >
    90399039    <desc>
    9040       TODO
     9040      Process waiting results. Depending on the process waiting flags (for
     9041      more information see <link to="ProcessWaitForFlag"/>) the waiting result
     9042      can vary based on the processes' current status.
     9043
     9044      To wait for a gust process to terminate after it has been
     9045      created by <link to="IGuestSession::processCreate"/> or <link to="IGuestSession::processCreateEx"/>
     9046      one would specify ProcessWaitResult_Terminate.
     9047
     9048      If a guest process has been started with <link to="ProcessCreateFlag::WaitForStdOut"/>
     9049      a client can wait with ProcessWaitResult_StdOut for new data to arrive on
     9050      stdout; same applies for <link to="ProcessCreateFlag::WaitForStdErr"/> and
     9051      ProcessWaitResult_StdErr.
    90419052    </desc>
    90429053
    90439054    <const name="None"                    value="0">
    9044       <desc>TODO</desc>
     9055      <desc>No result was returned. Not being used.</desc>
    90459056    </const>
    90469057    <const name="Start"                   value="1">
    9047       <desc>TODO</desc>
     9058      <desc>The process has been started.</desc>
    90489059    </const>
    90499060    <const name="Terminate"               value="2">
    9050       <desc>TODO</desc>
     9061      <desc>The process has been terminated.</desc>
    90519062    </const>
    90529063    <const name="Status"                  value="3">
    9053       <desc>TODO</desc>
    9054     </const>   
     9064      <desc>
     9065        The process has changed its status. The status then can
     9066        be retrieved via <link to="IProcess::status"/>.
     9067      </desc>
     9068    </const>
    90559069    <const name="Error"                   value="4">
    9056       <desc>TODO</desc>
    9057     </const>   
     9070      <desc>Error while executing the process.</desc>
     9071    </const>
    90589072    <const name="Timeout"                 value="5">
    9059       <desc>TODO</desc>
    9060     </const>   
     9073      <desc>
     9074        The waiting operation timed out. This also will happen
     9075        when no event has been occured matching the specified the
     9076        current waiting flags in the <link to="IProcess::waitFor"/> call.
     9077      </desc>
     9078    </const>
    90619079    <const name="StdIn"                   value="6">
    9062       <desc>TODO</desc>
    9063     </const>   
     9080      <desc>
     9081        The process signalled that stdin became available for writing
     9082        and that the process awaits input now.</desc>
     9083    </const>
    90649084    <const name="StdOut"                  value="7">
    9065       <desc>TODO</desc>
    9066     </const>   
     9085      <desc>Data on stdout became available for reading.</desc>
     9086    </const>
    90679087    <const name="StdErr"                  value="8">
    9068       <desc>TODO</desc>
     9088      <desc>Data on stderr became available for reading.</desc>
    90699089    </const>
    90709090    <const name="Any"                     value="9">
    9071       <desc>TODO</desc>
    9072     </const>   
     9091      <desc>
     9092        A waiting flag specified in the <link to="IProcess::waitFor"/> call
     9093        is not supported by the guest.
     9094      </desc>
     9095    </const>
    90739096  </enum>
    90749097
    … …  
    90789101    >
    90799102    <desc>
    9080       Host/Guest copy flags. At the moment none of these flags
    9081       are implemented.
     9103      File copying flags.
    90829104    </desc>
    90839105    <const name="None"                    value="0">
    … …  
    91099131    </const>
    91109132  </enum>
    9111  
     9133
    91129134  <enum
    91139135    name="DirectoryRemoveRecFlag"
    … …  
    91159137    >
    91169138    <desc>
    9117       TODO
     9139      Directory recursive removement flags.
    91189140    </desc>
    91199141
    91209142    <const name="None"                    value="0">
    91219143      <desc>No flag set.</desc>
    9122     </const>   
     9144    </const>
    91239145    <const name="ContentAndDir"           value="1">
    9124       <desc>TODO</desc>
    9125     </const>   
     9146      <desc>Delete the content of the directory and the directory itself.</desc>
     9147    </const>
    91269148    <const name="ContentOnly"             value="2">
    9127       <desc>TODO</desc>
    9128     </const>   
     9149      <desc>Only delete the content of the directory, omit the directory it self.</desc>
     9150    </const>
    91299151  </enum>
    9130  
     9152
    91319153  <enum
    91329154    name="PathRenameFlag"
    … …  
    91349156    >
    91359157    <desc>
    9136       TODO
     9158      Path renaming flags.
    91379159    </desc>
    91389160
    91399161    <const name="None"                    value="0">
    91409162      <desc>No flag set.</desc>
    9141     </const>   
     9163    </const>
    91429164    <const name="NoReplace"               value="1">
    9143       <desc>TODO</desc>
    9144     </const> 
     9165      <desc>Do not replace anything.</desc>
     9166    </const>
    91459167    <const name="Replace"                 value="2">
    9146       <desc>TODO</desc>
    9147     </const> 
     9168      <desc>This will replace attempt any target which isn't a directory.</desc>
     9169    </const>
    91489170    <const name="NoSymlinks"              value="4">
    9149       <desc>TODO</desc>
    9150     </const> 
     9171      <desc>Don't allow symbolic links as part of the path.</desc>
     9172    </const>
    91519173  </enum>
    9152  
     9174
    91539175  <enum
    91549176    name="ProcessCreateFlag"
    … …  
    91859207    </const>
    91869208  </enum>
    9187  
     9209
    91889210  <enum
    91899211    name="ProcessPriority"
    … …  
    91919213    >
    91929214    <desc>
    9193       TODO
     9215      Process priorities.
    91949216    </desc>
    91959217
    91969218    <const name="Invalid"                 value="0">
    9197       <desc>TODO</desc>
    9198     </const>   
     9219      <desc>Invalid priority, do not use.</desc>
     9220    </const>
    91999221    <const name="Default"                 value="1">
    9200       <desc>TODO</desc>
    9201     </const>   
     9222      <desc>Default process priority determined by the OS.</desc>
     9223    </const>
    92029224  </enum>
    9203  
     9225
    92049226  <enum
    92059227    name="SymlinkType"
    … …  
    92079229    >
    92089230    <desc>
    9209       TODO
     9231      Symbolic link types.
    92109232    </desc>
    92119233
    92129234    <const name="Unknown"                 value="0">
    9213       <desc>TODO</desc>
    9214     </const>   
     9235      <desc>It is not known what is being targeted.</desc>
     9236    </const>
    92159237    <const name="Directory"               value="1">
    9216       <desc>TODO</desc>
    9217     </const>   
     9238      <desc>The link targets a directory.</desc>
     9239    </const>
    92189240    <const name="File"                    value="2">
    9219       <desc>TODO</desc>
    9220     </const>   
     9241      <desc>The link targets a file (or whatever else).</desc>
     9242    </const>
    92219243  </enum>
    9222  
     9244
    92239245  <enum
    92249246    name="SymlinkReadFlag"
    … …  
    92269248    >
    92279249    <desc>
    9228       TODO
     9250      Symbolic link reading flags.
    92299251    </desc>
    92309252
    92319253    <const name="None"                    value="0">
    9232       <desc>TODO.</desc>
    9233     </const>   
     9254      <desc>No flags set.</desc>
     9255    </const>
    92349256    <const name="NoSymlinks"              value="1">
    9235       <desc>TODO</desc>
    9236     </const>   
     9257      <desc>Don't allow symbolic links as part of the path.</desc>
     9258    </const>
    92379259  </enum>
    9238  
     9260
    92399261  <enum
    92409262    name="ProcessStatus"
    … …  
    92429264    >
    92439265    <desc>
    9244       Guest process execution status.
     9266      Process execution statuses.
    92459267    </desc>
    92469268    <const name="Undefined"               value="0">
    … …  
    92499271
    92509272    <const name="Starting"                value="10">
    9251       <desc>TODO</desc>
     9273      <desc>Process is being started.</desc>
    92529274    </const>
    92539275    <const name="Started"                 value="100">
    … …  
    92559277    </const>
    92569278    <const name="Paused"                  value="110">
    9257       <desc>TODO</desc>
     9279      <desc>Process has been paused.</desc>
    92589280    </const>
    92599281    <const name="Terminating"             value="480">
    9260       <desc>TODO</desc>
     9282      <desc>Process is being terminated.</desc>
    92619283    </const>
    92629284    <const name="TerminatedNormally"      value="500">
    … …  
    92799301    </const>
    92809302    <const name="Error"                   value="800">
    9281       <desc>Something went wrong (error code in flags).</desc>
     9303      <desc>Something went wrong.</desc>
    92829304    </const>
    92839305  </enum>
    9284  
     9306
    92859307  <enum
    92869308    name="FsObjType"
    … …  
    92889310    >
    92899311    <desc>
    9290       TODO
     9312      File system object type.
    92919313    </desc>
    92929314
    92939315    <const name="Undefined"               value="0">
    9294       <desc>TODO</desc>
    9295     </const>   
     9316      <desc>Type is undefined / unknown.</desc>
     9317    </const>
    92969318    <const name="FIFO"                    value="1">
    9297       <desc>TODO</desc>
    9298     </const>   
     9319      <desc>Named pipe.</desc>
     9320    </const>
    92999321    <const name="DevChar"                 value="10">
    9300       <desc>TODO</desc>
    9301     </const>   
     9322      <desc>Character device.</desc>
     9323    </const>
    93029324    <const name="DevBlock"                value="11">
    9303       <desc>TODO</desc>
    9304     </const>   
     9325      <desc>Block device.</desc>
     9326    </const>
    93059327    <const name="Directory"               value="50">
    9306       <desc>TODO</desc>
    9307     </const>   
     9328      <desc>Directory.</desc>
     9329    </const>
    93089330    <const name="File"                    value="80">
    9309       <desc>TODO</desc>
    9310     </const>   
     9331      <desc>File.</desc>
     9332    </const>
    93119333    <const name="Symlink"                 value="100">
    9312       <desc>TODO</desc>
    9313     </const>   
     9334      <desc>Symlink.</desc>
     9335    </const>
    93149336    <const name="Socket"                  value="200">
    9315       <desc>TODO</desc>
    9316     </const>   
     9337      <desc>Socket.</desc>
     9338    </const>
    93179339    <const name="Whiteout"                value="400">
    9318       <desc>TODO</desc>
    9319     </const>   
     9340      <desc>Whiteout.</desc>
     9341    </const>
    93209342  </enum>
    93219343
    … …  
    93999421    </attribute>
    94009422  </interface>
    9401  
     9423
    94029424  <interface
    94039425    name="IGuestSession" extends="$unknown"
    9404     uuid="45aca317-55d7-4b6c-bbec-d053289118b9"
     9426    uuid="57eb82a8-822b-42c1-9d1c-5c54bc3d3250"
    94059427    wsmap="managed"
    94069428    >
    9407    
     9429
    94089430    <attribute name="user" type="wstring" readonly="yes">
    9409       <desc>
    9410         TODO
    9411         <note>
    9412           TODO
    9413         </note>
    9414       </desc>
    9415     </attribute>
    9416    
     9431      <desc>Returns the user name used by this session to impersonate
     9432        users on the guest.
     9433      </desc>
     9434    </attribute>
     9435
    94179436    <attribute name="domain" type="wstring" readonly="yes">
    9418       <desc>
    9419         TODO
    9420         <note>
    9421           TODO
    9422         </note>
    9423       </desc>
    9424     </attribute>
    9425    
     9437      <desc>Returns the domain name used by this session to impersonate
     9438        users on the guest.
     9439      </desc>
     9440    </attribute>
     9441
    94269442    <attribute name="name" type="wstring" readonly="yes">
    9427       <desc>
    9428         TODO
    9429         <note>
    9430           TODO
    9431         </note>
    9432       </desc>
    9433     </attribute>
    9434    
     9443      <desc>Returns the session's friendly name.</desc>
     9444    </attribute>
     9445
    94359446    <attribute name="id" type="unsigned long" readonly="yes">
    9436       <desc>
    9437         TODO
    9438         <note>
    9439           TODO
    9440         </note>
    9441       </desc>
    9442     </attribute>
    9443    
     9447      <desc>Returns the internal session ID.</desc>
     9448    </attribute>
     9449
    94449450    <attribute name="timeout" type="unsigned long" readonly="no">
    94459451      <desc>
    9446         TODO
    9447         <note>
    9448           TODO
    9449         </note>
    9450       </desc>
    9451     </attribute>
    9452    
     9452        Returns the session timeout (in ms).
     9453        <result name="E_NOTIMPL">
     9454          The method is not implemented yet.
     9455        </result>
     9456      </desc>
     9457    </attribute>
     9458
    94539459    <attribute name="environment" type="wstring" safearray="yes">
    94549460      <desc>
    9455         TODO
    9456       </desc>
    9457     </attribute>
    9458    
     9461        Returns the current session environment.
     9462      </desc>
     9463    </attribute>
     9464
    94599465    <attribute name="processes" type="IGuestProcess" readonly="yes" safearray="yes">
    94609466      <desc>
    9461         TODO
    9462       </desc>
    9463     </attribute>
    9464    
     9467        Returns all current guest processes.
     9468      </desc>
     9469    </attribute>
     9470
    94659471    <attribute name="directories" type="IGuestDirectory" readonly="yes" safearray="yes">
    94669472      <desc>
    9467         TODO
    9468       </desc>
    9469     </attribute>
    9470    
     9473        Returns all currently opened guest directories.
     9474      </desc>
     9475    </attribute>
     9476
    94719477    <attribute name="files" type="IGuestFile" readonly="yes" safearray="yes">
    94729478      <desc>
    9473         TODO
    9474       </desc>
    9475     </attribute>
    9476    
     9479        Returns all currently opened guest files.
     9480      </desc>
     9481    </attribute>
     9482
    94779483    <method name="close">
    94789484      <desc>
    9479         TODO
    9480 
    9481         <result name="VBOX_E_NOT_SUPPORTED">
    9482           TODO
    9483         </result>
    9484       </desc>
    9485     </method>
    9486    
     9485        Closes this session. All opened guest directories, files and
     9486        processes which are not referenced by clients anymore will be
     9487        uninitialized.
     9488      </desc>
     9489    </method>
     9490
    94879491    <method name="copyFrom">
    94889492      <desc>
    9489         TODO
    9490 
    9491         <result name="VBOX_E_NOT_SUPPORTED">
    9492           TODO
     9493        Copies a file from guest to the host.
     9494
     9495        <result name="VBOX_E_IPRT_ERROR">
     9496          Error starting the copy operation.
    94939497        </result>
    94949498      </desc>
    94959499      <param name="source" type="wstring" dir="in">
    9496         <desc>TODO</desc>
     9500        <desc>Source file on the guest to copy to the host.</desc>
    94979501      </param>
    94989502      <param name="dest" type="wstring" dir="in">
    9499         <desc>TODO</desc>
     9503        <desc>Destination file name on the host.</desc>
    95009504      </param>
    95019505      <param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
    9502         <desc>TODO</desc>
     9506        <desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
    95039507      </param>
    95049508      <param name="progress" type="IProgress" dir="return">
    … …  
    95069510      </param>
    95079511    </method>
    9508    
     9512
    95099513    <method name="copyTo">
    95109514      <desc>
    9511         TODO
    9512 
    9513         <result name="VBOX_E_NOT_SUPPORTED">
    9514           TODO
     9515        Copies a file from host to the guest.
     9516
     9517        <result name="VBOX_E_IPRT_ERROR">
     9518          Error starting the copy operation.
    95159519        </result>
    95169520      </desc>
    95179521      <param name="source" type="wstring" dir="in">
    9518         <desc>TODO</desc>
     9522        <desc>Source file on the host to copy to the guest.</desc>
    95199523      </param>
    95209524      <param name="dest" type="wstring" dir="in">
    9521         <desc>TODO</desc>
     9525        <desc>Destination file name on the guest.</desc>
    95229526      </param>
    95239527      <param name="flags" type="CopyFileFlag" dir="in" safearray="yes">
    9524         <desc>TODO</desc>
     9528        <desc>Copy flags; see <link to="CopyFileFlag"/> for more information.</desc>
    95259529      </param>
    95269530      <param name="progress" type="IProgress" dir="return">
    … …  
    95289532      </param>
    95299533    </method>
    9530    
     9534
    95319535    <method name="directoryCreate">
    95329536      <desc>
    9533         TODO
    9534 
    9535         <result name="VBOX_E_NOT_SUPPORTED">
    9536           TODO
     9537        Create a directory on the guest.
     9538
     9539        <result name="VBOX_E_IPRT_ERROR">
     9540          Error while creating the directory.
    95379541        </result>
    95389542      </desc>
    95399543      <param name="path" type="wstring" dir="in">
    9540         <desc>TODO</desc>
     9544        <desc>Full path of directory to create.</desc>
    95419545      </param>
    95429546      <param name="mode" type="unsigned long" dir="in">
    9543         <desc>TODO</desc>
     9547        <desc>File creation mode.</desc>
    95449548      </param>
    95459549      <param name="flags" type="DirectoryCreateFlag" dir="in" safearray="yes">
    9546         <desc>TODO</desc>
    9547       </param>
    9548       <param name="directory" type="IGuestDirectory" dir="return">
    9549         <desc>Optional.</desc>
    9550       </param>
    9551     </method>
    9552    
     9550        <desc>Creation flags; see <link to="DirectoryCreateFlag"/> for more information.</desc>
     9551      </param>
     9552    </method>
     9553
    95539554    <method name="directoryCreateTemp">
    95549555      <desc>
    … …  
    95959596      </param>
    95969597    </method>
    9597    
     9598
    95989599    <method name="directoryExists">
    95999600      <desc>
    9600         TODO
    9601 
    9602         <result name="VBOX_E_NOT_SUPPORTED">
    9603           TODO
     9601        Checks whether a directory exists on the guest or not.
     9602
     9603        <result name="VBOX_E_IPRT_ERROR">
     9604          Error while checking existence of the directory specified.
    96049605        </result>
    96059606      </desc>
    96069607      <param name="path" type="wstring" dir="in">
    9607         <desc>TODO</desc>
     9608        <desc>Directory to check existence for.</desc>
    96089609      </param>
    96099610      <param name="exists" type="boolean" dir="return">
    9610         <desc>TODO</desc>
    9611       </param>
    9612     </method>
    9613    
     9611        <desc>Returns @c true if the directory exists, @c false if not.</desc>
     9612      </param>
     9613    </method>
     9614
    96149615    <method name="directoryOpen">
    96159616      <desc>
    9616         TODO
    9617 
    9618         <result name="VBOX_E_NOT_SUPPORTED">
    9619           TODO
     9617        Opens a directory and creates a <link to="IGuestDirectory"/> object that
     9618        can be used for further operations.
     9619
     9620        <result name="VBOX_E_OBJECT_NOT_FOUND">
     9621          Directory to open was not found.
     9622        </result>
     9623        <result name="VBOX_E_IPRT_ERROR">
     9624          Error while opening the directory.
    96209625        </result>
    96219626      </desc>
    96229627      <param name="path" type="wstring" dir="in">
    9623         <desc>TODO</desc>
     9628        <desc>Full path to file to open.</desc>
    96249629      </param>
    96259630      <param name="filter" type="wstring" dir="in">
    9626         <desc>TODO</desc>
     9631        <desc>Open filter to apply. This can include wildcards like ? and *.</desc>
    96279632      </param>
    96289633      <param name="flags" type="DirectoryOpenFlag" dir="in" safearray="yes">
    9629         <desc>TODO</desc>
     9634        <desc>Open flags; see <link to="DirectoryOpenFlag"/> for more information.</desc>
    96309635      </param>
    96319636      <param name="directory" type="IGuestDirectory" dir="return">
    9632         <desc>TODO</desc>
    9633       </param>
    9634     </method>
    9635    
     9637        <desc><link to="IGuestDirectory"/> object containing the opened directory.</desc>
     9638      </param>
     9639    </method>
     9640
    96369641    <method name="directoryQueryInfo">
    96379642      <desc>
    9638         TODO
    9639 
    9640         <result name="VBOX_E_NOT_SUPPORTED">
    9641           TODO
     9643        Queries information of a directory on the guest.
     9644
     9645        <result name="VBOX_E_OBJECT_NOT_FOUND">
     9646          Directory to query information for was not found.
     9647        </result>
     9648        <result name="VBOX_E_IPRT_ERROR">
     9649          Error querying information.
    96429650        </result>
    96439651      </desc>
    96449652      <param name="path" type="wstring" dir="in">
    9645         <desc>TODO</desc>
     9653        <desc>Directory to query information for.</desc>
    96469654      </param>
    96479655      <param name="info" type="IGuestFsObjInfo" dir="return">
    9648         <desc>TODO</desc>
    9649       </param>
    9650     </method>
    9651    
     9656        <desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
     9657      </param>
     9658    </method>
     9659
    96529660    <method name="directoryRemove">
    96539661      <desc>
    9654         TODO
    9655 
    9656         <result name="VBOX_E_NOT_SUPPORTED">
    9657           TODO
     9662        Removes a guest directory if not empty.
     9663
     9664        <result name="E_NOTIMPL">
     9665          The method is not implemented yet.
    96589666        </result>
    96599667      </desc>
    96609668      <param name="path" type="wstring" dir="in">
    9661         <desc>TODO</desc>
    9662       </param>
    9663     </method>
    9664    
     9669        <desc>Full path of directory to remove.</desc>
     9670      </param>
     9671    </method>
     9672
    96659673    <method name="directoryRemoveRecursive">
    96669674      <desc>
    9667         TODO
    9668 
    9669         <result name="VBOX_E_NOT_SUPPORTED">
    9670           TODO
     9675        Removes a guest directory recursively.
     9676
     9677        <result name="E_NOTIMPL">
     9678          The method is not implemented yet.
    96719679        </result>
    96729680      </desc>
    96739681      <param name="path" type="wstring" dir="in">
    9674         <desc>TODO</desc>
     9682        <desc>Full path of directory to remove recursively.</desc>
    96759683      </param>
    96769684      <param name="flags" type="DirectoryRemoveRecFlag" dir="in" safearray="yes">
    9677         <desc>TODO</desc>
     9685        <desc>Remove flags; see <link to="DirectoryRemoveRecFlag"/> for more information.</desc>
    96789686      </param>
    96799687      <param name="progress" type="IProgress" dir="return">
    9680         <desc>TODO</desc>
    9681       </param>
    9682     </method>
    9683    
     9688        <desc>Progress object to track the operation completion.</desc>
     9689      </param>
     9690    </method>
     9691
    96849692    <method name="directoryRename">
    96859693      <desc>
    9686         TODO
    9687 
    9688         <result name="VBOX_E_NOT_SUPPORTED">
    9689           TODO
     9694        Renames a directory on the guest.
     9695
     9696        <result name="E_NOTIMPL">
     9697          The method is not implemented yet.
    96909698        </result>
    96919699      </desc>
    96929700      <param name="source" type="wstring" dir="in">
    9693         <desc>TODO</desc>
     9701        <desc>Source directory to rename.</desc>
    96949702      </param>
    96959703      <param name="dest" type="wstring" dir="in">
    9696         <desc>TODO</desc>
    9697       </param>
    9698       <param name="flags" type="PathRenameFlag" dir="in" safearray="yes"> 
    9699         <desc>TODO</desc>
    9700       </param>
    9701     </method>
    9702    
     9704        <desc>Destination directory to rename the source to.</desc>
     9705      </param>
     9706      <param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
     9707        <desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
     9708      </param>
     9709    </method>
     9710
    97039711    <method name="directorySetACL">
    97049712      <desc>
    9705         TODO
    9706 
    9707         <result name="VBOX_E_NOT_SUPPORTED">
    9708           TODO
     9713        Sets the ACL (Access Control List) of a guest directory.
     9714
     9715        <result name="E_NOTIMPL">
     9716          The method is not implemented yet.
    97099717        </result>
    97109718      </desc>
    97119719      <param name="path" type="wstring" dir="in">
    9712         <desc>TODO</desc>
     9720        <desc>Full path of directory to set the ACL for.</desc>
    97139721      </param>
    97149722      <param name="acl" type="wstring" dir="in">
    9715         <desc>TODO</desc>
    9716       </param>
    9717     </method>
    9718    
     9723        <desc>Actual ACL string to set. Must comply with the guest OS.</desc>
     9724      </param>
     9725    </method>
     9726
    97199727    <method name="environmentClear">
    97209728      <desc>
    9721         TODO
    9722 
    9723         <result name="VBOX_E_NOT_SUPPORTED">
    9724           TODO
    9725         </result>
    9726       </desc>
    9727     </method>
    9728    
     9729        Clears (deletes) all session environment variables.
     9730
     9731        <result name="VBOX_E_IPRT_ERROR">
     9732          Error while clearing the session environment variables.
     9733        </result>
     9734      </desc>
     9735    </method>
     9736
    97299737    <method name="environmentGet">
    97309738      <desc>
    9731         TODO
    9732 
    9733         <result name="VBOX_E_NOT_SUPPORTED">
    9734           TODO
     9739        Gets the value of a session environment variable.
     9740
     9741        <result name="VBOX_E_IPRT_ERROR">
     9742          Error while getting the value of the session environment variable.
    97359743        </result>
    97369744      </desc>
    97379745      <param name="name" type="wstring" dir="in">
    9738         <desc>TODO</desc>
     9746        <desc>Name of session environment variable to get the value for.</desc>
    97399747      </param>
    97409748      <param name="value" type="wstring" dir="return">
    9741         <desc>TODO</desc>
    9742       </param>
    9743     </method>
    9744    
     9749        <desc>
     9750          Value of the session environment variable specified. If this variable
     9751          does not exist and empty value will be returned.
     9752        </desc>
     9753      </param>
     9754    </method>
     9755
    97459756    <method name="environmentSet">
    97469757      <desc>
    9747         TODO
    9748 
    9749         <result name="VBOX_E_NOT_SUPPORTED">
    9750           TODO
     9758        Sets a session environment variable.
     9759
     9760        <result name="VBOX_E_IPRT_ERROR">
     9761          Error while setting the session environment variable.
    97519762        </result>
    97529763      </desc>
    97539764      <param name="name" type="wstring" dir="in">
    9754         <desc>TODO</desc>
     9765        <desc>Name of session environment variable to set.</desc>
    97559766      </param>
    97569767      <param name="value" type="wstring" dir="in">
    9757         <desc>TODO</desc>
    9758       </param>
    9759     </method>
    9760    
     9768        <desc>Value to set the session environment variable to.</desc>
     9769      </param>
     9770    </method>
     9771
    97619772    <method name="environmentUnset">
    97629773      <desc>
    9763         TODO
    9764 
    9765         <result name="VBOX_E_NOT_SUPPORTED">
    9766           TODO
     9774        Unsets session environment variable.
     9775
     9776        <result name="VBOX_E_IPRT_ERROR">
     9777          Error while unsetting the session environment variable.
    97679778        </result>
    97689779      </desc>
    97699780      <param name="name" type="wstring" dir="in">
    9770         <desc>TODO</desc>
    9771       </param>
    9772     </method>
    9773    
     9781        <desc>Name of session environment variable to unset (clear).</desc>
     9782      </param>
     9783    </method>
     9784
    97749785    <method name="fileCreateTemp">
    97759786      <desc>
    9776         Create a temporary file on the guest.
     9787        Creates a temporary file on the guest.
    97779788
    97789789        <result name="VBOX_E_NOT_SUPPORTED">
    … …  
    97819792        </result>
    97829793        <result name="E_INVALIDARG">
    9783           Invalid argument.  This includes an incorrectly formatted template,
     9794          Invalid argument. This includes an incorrectly formatted template,
    97849795          or a non-absolute path.
    97859796        </result>
    97869797        <result name="VBOX_E_IPRT_ERROR">
    9787           The temporary file could not be created.  Possible reasons include
     9798          The temporary file could not be created. Possible reasons include
    97889799          a non-existing path or an insecure path when the secure
    97899800          option was requested.
    … …  
    97919802      </desc>
    97929803      <param name="templateName" type="wstring" dir="in">
    9793         <desc>Template for the name of the file to create.  This must contain
     9804        <desc>Template for the name of the file to create. This must contain
    97949805          at least one 'X' character.  The first group of consecutive 'X'
    97959806          characters in the template will be replaced by a random
    … …  
    97989809      </param>
    97999810      <param name="mode" type="unsigned long" dir="in">
    9800         <desc>The mode of the file to create.  Use 0700 unless there are
     9811        <desc>The mode of the file to create. Use 0700 unless there are
    98019812          reasons not to.  This parameter is ignored if "secure" is specified.
    98029813         </desc>
    … …  
    98189829      </param>
    98199830    </method>
    9820    
     9831
    98219832    <method name="fileExists">
    98229833      <desc>
    9823         TODO
    9824 
    9825         <result name="VBOX_E_NOT_SUPPORTED">
    9826           TODO
     9834        Checks whether a file exists on the guest or not.
     9835
     9836        <result name="VBOX_E_IPRT_ERROR">
     9837          Error while checking existence of the file specified.
    98279838        </result>
    98289839      </desc>
    98299840      <param name="path" type="wstring" dir="in">
    9830         <desc>TODO</desc>
     9841        <desc>File to check existence for.</desc>
    98319842      </param>
    98329843      <param name="exists" type="boolean" dir="return">
    9833         <desc>TODO</desc>
    9834       </param>
    9835     </method>
    9836    
     9844        <desc>Returns @c true if the file exists, @c false if not.</desc>
     9845      </param>
     9846    </method>
     9847
    98379848    <method name="fileRemove">
    98389849      <desc>
    9839         Remove a single file on the guest.
    9840 
     9850        Removes a single file on the guest.
     9851
     9852        <result name="VBOX_E_OBJECT_NOT_FOUND">
     9853          File to remove was not found.
     9854        </result>
     9855        <result name="VBOX_E_IPRT_ERROR">
     9856          Error while removing the file.
     9857        </result>
    98419858      </desc>
    98429859      <param name="path" type="wstring" dir="in">
    … …  
    98449861      </param>
    98459862    </method>
    9846    
     9863
    98479864    <method name="fileOpen">
    98489865      <desc>
    9849         TODO
    9850 
    9851         <result name="VBOX_E_NOT_SUPPORTED">
    9852           TODO
     9866        Opens a file and creates a <link to="IGuestFile"/> object that
     9867        can be used for further operations.
     9868
     9869        <result name="VBOX_E_OBJECT_NOT_FOUND">
     9870          File to open was not found.
     9871        </result>
     9872        <result name="VBOX_E_IPRT_ERROR">
     9873          Error while opening the file.
    98539874        </result>
    98549875      </desc>
    98559876      <param name="path" type="wstring" dir="in">
    9856         <desc>TODO</desc>
     9877        <desc>Full path to file to open.</desc>
    98579878      </param>
    98589879      <param name="openMode" type="wstring" dir="in">
    9859         <desc>TODO</desc>
     9880        <desc>The file open mode.</desc>
    98609881      </param>
    98619882      <param name="disposition" type="wstring" dir="in">
    9862         <desc>TODO</desc>
     9883        <desc>The file disposition.</desc>
    98639884      </param>
    98649885      <param name="creationMode" type="unsigned long" dir="in">
    9865         <desc>TODO</desc>
     9886        <desc>The file creation mode.</desc>
    98669887      </param>
    98679888      <param name="offset" type="long long" dir="in">
    9868         <desc>TODO</desc>
     9889        <desc>The initial read/write offset.</desc>
    98699890      </param>
    98709891      <param name="file" type="IGuestFile" dir="return">
    9871         <desc>TODO</desc>
    9872       </param>
    9873     </method>
    9874    
     9892        <desc><link to="IGuestFile"/> object representing the opened file.</desc>
     9893      </param>
     9894    </method>
     9895
    98759896    <method name="fileQueryInfo">
    98769897      <desc>
    9877         TODO
    9878 
    9879         <result name="VBOX_E_NOT_SUPPORTED">
    9880           TODO
     9898        Queries information of a file on the guest.
     9899
     9900        <result name="VBOX_E_OBJECT_NOT_FOUND">
     9901          File to query information for was not found.
     9902        </result>
     9903        <result name="VBOX_E_IPRT_ERROR">
     9904          Error querying information.
    98819905        </result>
    98829906      </desc>
    98839907      <param name="path" type="wstring" dir="in">
    9884         <desc>TODO</desc>
     9908        <desc>File to query information for.</desc>
    98859909      </param>
    98869910      <param name="info" type="IGuestFsObjInfo" dir="return">
    9887         <desc>TODO</desc>
    9888       </param>
    9889     </method>
    9890    
     9911        <desc><link to="IGuestFsObjInfo"/> object containing the queried information.</desc>
     9912      </param>
     9913    </method>
     9914
    98919915    <method name="fileQuerySize">
    98929916      <desc>
    9893         TODO
    9894 
    9895         <result name="VBOX_E_NOT_SUPPORTED">
    9896           TODO
     9917        Queries the size of a file on the guest.
     9918
     9919        <result name="VBOX_E_OBJECT_NOT_FOUND">
     9920          File to rename was not found.
     9921        </result>
     9922        <result name="VBOX_E_IPRT_ERROR">
     9923          Error querying file size.
    98979924        </result>
    98989925      </desc>
    98999926      <param name="path" type="wstring" dir="in">
    9900         <desc>TODO</desc>
     9927        <desc>File to query the size for.</desc>
    99019928      </param>
    99029929      <param name="size" type="long long" dir="return">
    9903         <desc>TODO</desc>
    9904       </param>
    9905     </method>
    9906    
     9930        <desc>Queried file size.</desc>
     9931      </param>
     9932    </method>
     9933
    99079934    <method name="fileRename">
    99089935      <desc>
    9909         TODO
    9910 
    9911         <result name="VBOX_E_NOT_SUPPORTED">
    9912           TODO
     9936        Renames a file on the guest.
     9937
     9938        <result name="E_NOTIMPL">
     9939          The method is not implemented yet.
    99139940        </result>
    99149941      </desc>
    99159942      <param name="source" type="wstring" dir="in">
    9916         <desc>TODO</desc>
     9943        <desc>Source file to rename.</desc>
    99179944      </param>
    99189945      <param name="dest" type="wstring" dir="in">
    9919         <desc>TODO</desc>
     9946        <desc>Destination file to rename the source to.</desc>
    99209947      </param>
    99219948      <param name="flags" type="PathRenameFlag" dir="in" safearray="yes">
    9922         <desc>TODO</desc>
    9923       </param>
    9924     </method>
    9925    
     9949        <desc>Rename flags; see <link to="PathRenameFlag"/> for more information.</desc>
     9950      </param>
     9951    </method>
     9952
    99269953    <method name="fileSetACL">
    99279954      <desc>
    9928         TODO
    9929 
    9930         <result name="VBOX_E_NOT_SUPPORTED">
    9931           TODO
     9955        Sets the ACL (Access Control List) of a file on the guest.
     9956
     9957        <result name="E_NOTIMPL">
     9958          The method is not implemented yet.
    99329959        </result>
    99339960      </desc>
    99349961      <param name="file" type="wstring" dir="in">
    9935         <desc>TODO</desc>
     9962        <desc>Full path of file to set the ACL for.</desc>
    99369963      </param>
    99379964      <param name="acl" type="wstring" dir="in">
    9938         <desc>TODO</desc>
    9939       </param>
    9940     </method>
    9941    
     9965        <desc>Actual ACL string to set. Must comply with the guest OS.</desc>
     9966      </param>
     9967    </method>
     9968
    99429969    <method name="processCreate">
    99439970      <desc>
    9944         TODO
    9945 
    9946         <result name="VBOX_E_NOT_SUPPORTED">
    9947           TODO
     9971        Executes an existing program inside the guest VM.
     9972
     9973        <note>
     9974          Starting at VirtualBox 4.2 guest process execution by default is limited
     9975          to serve up to 255 guest processes at a time. If all 255 guest processes
     9976          are still active and running, starting a new guest process will result in an
     9977          appropriate error message.
     9978
     9979          If <link to="ProcessCreateFlag::ProcessCreateFlag_WaitForStdOut"/>
     9980          and / or respectively <link to="ProcessCreateFlag::ProcessCreateFlag_WaitForStdErr"/>
     9981          is set, the guest process will not exit until all data from the specified
     9982          stream(s) is/are read out.
     9983
     9984          To raise or lower the guest process execution limit, either the guest property
     9985          "/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
     9986          command line by specifying "--control-procs-max-kept" needs to be modified.
     9987          A restart of the guest OS is required afterwards. To serve unlimited guest
     9988          processes, a value of "0" needs to be set (not recommended).
     9989        </note>
     9990
     9991        <result name="VBOX_E_IPRT_ERROR">
     9992          Could not create process.
    99489993        </result>
    99499994      </desc>
    99509995      <param name="command" type="wstring" dir="in">
    9951         <desc>TODO</desc>
     9996        <desc>
     9997          Full path name of the command to execute on the guest; the
     9998          commands has to exists in the guest VM in order to be executed.
     9999        </desc>
    995210000      </param>
    995310001      <param name="arguments" type="wstring" dir="in" safearray="yes">
    9954         <desc>TODO</desc>
     10002        <desc>Array of arguments passed to the execution command.</desc>
    995510003      </param>
    995610004      <param name="environment" type="wstring" dir="in" safearray="yes">
    9957         <desc>TODO</desc>
     10005        <desc>
     10006          Environment variables that can be set while the command is being
     10007          executed, in form of "NAME=VALUE"; one pair per entry. To unset a
     10008          variable just set its name ("NAME") without a value.
     10009
     10010          This parameter can be used to override environment variables set by
     10011          the guest session, which will be applied to the newly started process
     10012          in any case.
     10013        </desc>
    995810014      </param>
    995910015      <param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
    9960         <desc>TODO</desc>
     10016        <desc>
     10017          Process creation flags;
     10018          see <link to="ProcessCreateFlag"/> for more information.
     10019        </desc>
    996110020      </param>
    996210021      <param name="timeoutMS" type="unsigned long" dir="in">
    9963         <desc>TODO</desc>
     10022        <desc>
     10023          Timeout (in ms) to wait for the operation to complete.
     10024          Pass 0 for an infinite timeout.
     10025        </desc>
    996410026      </param>
    996510027      <param name="guestProcess" type="IGuestProcess" dir="return">
    9966         <desc>TODO</desc>
    9967       </param>
    9968     </method>
    9969    
     10028        <desc>Guest process object of the newly created process.</desc>
     10029      </param>
     10030    </method>
     10031
    997010032    <method name="processCreateEx">
    997110033      <desc>
    9972         TODO
    9973 
    9974         <result name="VBOX_E_NOT_SUPPORTED">
    9975           TODO
     10034        Executes an existing program inside the guest VM. Extended version for
     10035        also setting the process priority and affinity.
     10036
     10037        <note>
     10038          Starting at VirtualBox 4.2 guest process execution by default is limited
     10039          to serve up to 255 guest processes at a time. If all 255 guest processes
     10040          are still active and running, starting a new guest process will result in an
     10041          appropriate error message.
     10042
     10043          If <link to="ProcessCreateFlag::ProcessCreateFlag_WaitForStdOut"/>
     10044          and / or respectively <link to="ProcessCreateFlag::ProcessCreateFlag_WaitForStdErr"/>
     10045          is set, the guest process will not exit until all data from the specified
     10046          stream(s) is/are read out.
     10047
     10048          To raise or lower the guest process execution limit, either the guest property
     10049          "/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
     10050          command line by specifying "--control-procs-max-kept" needs to be modified.
     10051          A restart of the guest OS is required afterwards. To serve unlimited guest
     10052          processes, a value of "0" needs to be set (not recommended).
     10053        </note>
     10054
     10055        <result name="VBOX_E_IPRT_ERROR">
     10056          Could not create process.
    997610057        </result>
    997710058      </desc>
    997810059      <param name="command" type="wstring" dir="in">
    9979         <desc>TODO</desc>
     10060        <desc>
     10061          Full path name of the command to execute on the guest; the
     10062          commands has to exists in the guest VM in order to be executed.
     10063        </desc>
    998010064      </param>
    998110065      <param name="arguments" type="wstring" dir="in" safearray="yes">
    9982         <desc>TODO</desc>
     10066        <desc>Array of arguments passed to the execution command.</desc>
    998310067      </param>
    998410068      <param name="environment" type="wstring" dir="in" safearray="yes">
    9985         <desc>TODO</desc>
     10069        <desc>
     10070          Environment variables that can be set while the command is being
     10071          executed, in form of "NAME=VALUE"; one pair per entry. To unset a
     10072          variable just set its name ("NAME") without a value.
     10073
     10074          This parameter can be used to override environment variables set by
     10075          the guest session, which will be applied to the newly started process
     10076          in any case.
     10077        </desc>
    998610078      </param>
    998710079      <param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">
    9988         <desc>TODO</desc>
     10080        <desc>
     10081          Process creation flags;
     10082          see <link to="ProcessCreateFlag"/> for more information.
     10083        </desc>
    998910084      </param>
    999010085      <param name="timeoutMS" type="unsigned long" dir="in">
    9991         <desc>TODO</desc>
     10086        <desc>
     10087          Timeout (in ms) to wait for the operation to complete.
     10088          Pass 0 for an infinite timeout.
     10089        </desc>
    999210090      </param>
    999310091      <param name="priority" type="ProcessPriority" dir="in">
    9994         <desc>TODO</desc>
     10092        <desc>
     10093          Process priority to use for execution;
     10094          see see <link to="ProcessPriority"/> for more information.</desc>
    999510095      </param>
    999610096      <param name="affinity" type="long" dir="in" safearray="yes">
    9997         <desc>TODO</desc>
     10097        <desc>
     10098          Process affinity to use for execution. This parameter
     10099          is not implemented yet.
     10100        </desc>
    999810101      </param>
    999910102      <param name="guestProcess" type="IGuestProcess" dir="return">
    10000         <desc>TODO</desc>
    10001       </param>
    10002     </method>
    10003    
     10103        <desc>Guest process object of the newly created process.</desc>
     10104      </param>
     10105    </method>
     10106
    1000410107    <method name="processGet">
    1000510108      <desc>
    10006         TODO
    10007 
    10008         <result name="VBOX_E_NOT_SUPPORTED">
    10009           TODO
    10010         </result>
     10109        Gets a certain guest process by its process ID (PID).
    1001110110      </desc>
    1001210111      <param name="pid" type="unsigned long" dir="in">
    10013         <desc>TODO</desc>
     10112        <desc>Process ID (PID) to get guest process for.</desc>
    1001410113      </param>
    1001510114      <param name="guestProcess" type="IGuestProcess" dir="return">
    10016         <desc>TODO</desc>
    10017       </param>
    10018     </method>
    10019    
     10115        <desc>Guest process of specified process ID (PID).</desc>
     10116      </param>
     10117    </method>
     10118
    1002010119    <method name="symlinkCreate">
    1002110120      <desc>
    10022         TODO
    10023 
    10024         <result name="VBOX_E_NOT_SUPPORTED">
    10025           TODO
     10121        Creates a symbolic link on the guest.
     10122
     10123        <result name="E_NOTIMPL">
     10124          The method is not implemented yet.
    1002610125        </result>
    1002710126      </desc>
    1002810127      <param name="source" type="wstring" dir="in">
    10029         <desc>TODO</desc>
     10128        <desc>The name of the symbolic link.</desc>
    1003010129      </param>
    1003110130      <param name="target" type="wstring" dir="in">
    10032         <desc>TODO</desc>
     10131        <desc>The path to the symbolic link target.</desc>
    1003310132      </param>
    1003410133      <param name="type" type="SymlinkType" dir="in">
    10035         <desc>TODO</desc>
    10036       </param>
    10037     </method>
    10038    
     10134        <desc>
     10135          The symbolic link type;
     10136          see <link to="SymlinkReadFlag"/> for more information.
     10137        </desc>
     10138      </param>
     10139    </method>
     10140
    1003910141    <method name="symlinkExists">
    1004010142      <desc>
    10041         TODO
    10042 
    10043         <result name="VBOX_E_NOT_SUPPORTED">
    10044           TODO
     10143        Checks whether a symbolic link exists on the guest or not.
     10144
     10145        <result name="E_NOTIMPL">
     10146          The method is not implemented yet.
    1004510147        </result>
    1004610148      </desc>
    1004710149      <param name="symlink" type="wstring" dir="in">
    10048         <desc>TODO</desc>
     10150        <desc>Symbolic link to check existence for.</desc>
    1004910151      </param>
    1005010152      <param name="exists" type="boolean" dir="return">
    10051         <desc>TODO</desc>
    10052       </param>
    10053     </method>
    10054    
     10153        <desc>Returns @c true if the symbolic link exists, @c false if not.</desc>
     10154      </param>
     10155    </method>
     10156
    1005510157    <method name="symlinkRead">
    1005610158      <desc>
    10057         TODO
    10058 
    10059         <result name="VBOX_E_NOT_SUPPORTED">
    10060           TODO
     10159        Reads a symbolic link on the guest.
     10160
     10161        <result name="E_NOTIMPL">
     10162          The method is not implemented yet.
    1006110163        </result>
    1006210164      </desc>
    1006310165      <param name="symlink" type="wstring" dir="in">
    10064         <desc>TODO</desc>
     10166        <desc>Full path to symbolic link to read.</desc>
    1006510167      </param>
    1006610168      <param name="flags" type="SymlinkReadFlag" dir="in" safearray="yes">
    10067         <desc>TODO</desc>
     10169        <desc>
     10170          Read flags; see <link to="SymlinkReadFlag"/> for more information.
     10171        </desc>
    1006810172      </param>
    1006910173      <param name="target" type="wstring" dir="return">
    10070         <desc>TODO</desc>
    10071       </param>
    10072     </method>
    10073    
     10174        <desc>
     10175          Target of the symbolic link pointing to, if found.
     10176        </desc>
     10177      </param>
     10178    </method>
     10179
    1007410180    <method name="symlinkRemoveDirectory">
    1007510181      <desc>
    10076         TODO
    10077 
    10078         <result name="VBOX_E_NOT_SUPPORTED">
    10079           TODO
     10182        Removes a symbolic link on the guest if it's a directory.
     10183
     10184        <result name="E_NOTIMPL">
     10185          The method is not implemented yet.
    1008010186        </result>
    1008110187      </desc>
    1008210188      <param name="path" type="wstring" dir="in">
    10083         <desc>TODO</desc>
    10084       </param>
    10085     </method>
    10086    
     10189        <desc>Symbolic link to remove.</desc>
     10190      </param>
     10191    </method>
     10192
    1008710193    <method name="symlinkRemoveFile">
    1008810194      <desc>
    10089         TODO
    10090 
    10091         <result name="VBOX_E_NOT_SUPPORTED">
    10092           TODO
     10195        Removes a symbolic link on the guest if it's a file.
     10196
     10197        <result name="E_NOTIMPL">
     10198          The method is not implemented yet.
    1009310199        </result>
    1009410200      </desc>
    1009510201      <param name="file" type="wstring" dir="in">
    10096         <desc>TODO</desc>
    10097       </param>
    10098     </method>
    10099    
    10100   </interface>   
     10202        <desc>Symbolic link to remove.</desc>
     10203      </param>
     10204    </method>
     10205
     10206  </interface>
    1010110207
    1010210208  <interface
    1010310209    name="IProcess" extends="$unknown"
    10104     uuid="896df50a-c5d1-4892-8bc6-b78d0c1f4e33"
     10210    uuid="08864d56-96ab-418b-adbc-5a679532aeb0"
    1010510211    wsmap="managed"
    1010610212    >
    1010710213    <desc>
    10108       TODO
     10214      Abstract parent interface for processes handled by VirtualBox.
    1010910215    </desc>
    1011010216    <attribute name="PID" type="unsigned long" readonly="yes">
    1011110217      <desc>
    10112         TODO
    10113         <note>
    10114           TODO
    10115         </note>
     10218        The process ID (PID).
    1011610219      </desc>
    1011710220    </attribute>
    1011810221    <attribute name="status" type="ProcessStatus" readonly="yes">
    1011910222      <desc>
    10120         TODO
    10121         <note>
    10122           TODO
    10123         </note>
     10223        The current process status; see <link to="ProcessStatus"/>
     10224        for more information.
    1012410225      </desc>
    1012510226    </attribute>
    1012610227    <attribute name="exitCode" type="long" readonly="yes">
    1012710228      <desc>
    10128         TODO
    10129         <note>
    10130           TODO
    10131         </note>
     10229        The exit code. Only available when the process has been
     10230        terminated normally.
    1013210231      </desc>
    1013310232    </attribute>
    1013410233    <attribute name="environment" type="wstring" readonly="yes" safearray="yes">
    1013510234      <desc>
    10136         TODO
    10137         <note>
    10138           TODO
    10139         </note>
     10235        The environment block this process is using during execution.
    1014010236      </desc>
    1014110237    </attribute>
    1014210238    <attribute name="arguments" type="wstring" readonly="yes" safearray="yes">
    1014310239      <desc>
    10144         TODO
    10145         <note>
    10146           TODO
    10147         </note>
     10240        The arguments this process is using for execution.
    1014810241      </desc>
    1014910242    </attribute>
    1015010243    <attribute name="executablePath" type="wstring" readonly="yes">
    10151       <desc>
    10152         TODO
    10153         <note>
    10154           TODO
    10155         </note>
    10156       </desc>
     10244      <desc>Full path of the actual executable image.</desc>
    1015710245    </attribute>
    1015810246    <attribute name="name" type="wstring" readonly="yes">
    10159       <desc>
    10160         TODO
    10161         <note>
    10162           TODO
    10163         </note>
    10164       </desc>
    10165     </attribute>
    10166    
     10247      <desc>The friendly name of this process.</desc>
     10248    </attribute>
     10249
    1016710250    <method name="waitFor">
    1016810251      <desc>
    10169         TODO
    10170 
    10171         <result name="VBOX_E_NOT_SUPPORTED">
    10172           TODO
    10173         </result>
     10252        Waits for one more events to happen.
    1017410253      </desc>
    1017510254      <param name="waitFor" type="unsigned long" dir="in">
    10176         <desc>TODO</desc>
     10255        <desc>
     10256          Specifies what to wait for;
     10257          see <link to="ProcessWaitForFlag"/> for more information.
     10258        </desc>
    1017710259      </param>
    1017810260      <param name="timeoutMS" type="unsigned long" dir="in">
    10179         <desc>TODO</desc>
     10261        <desc>
     10262          Timeout (in ms) to wait for the operation to complete.
     10263          Pass 0 for an infinite timeout.
     10264        </desc>
    1018010265      </param>
    1018110266      <param name="reason" type="ProcessWaitResult" dir="return">
    10182         <desc>TODO</desc>
    10183       </param>
    10184     </method>
    10185    
     10267        <desc>
     10268          The overall wait result;
     10269          see <link to="ProcessWaitResult"/> for more information.
     10270        </desc>
     10271      </param>
     10272    </method>
     10273
    1018610274    <method name="waitForArray">
    1018710275      <desc>
     10276        Waits for one more events to happen.
    1018810277        Scriptable version of <link to="#waitFor" />.
    10189 
    10190         <result name="VBOX_E_NOT_SUPPORTED">
    10191           TODO
    10192         </result>
    1019310278      </desc>
    1019410279      <param name="waitFor" type="ProcessWaitForFlag" dir="in" safearray="yes">
    10195         <desc>TODO</desc>
     10280        <desc>
     10281          Specifies what to wait for;
     10282          see <link to="ProcessWaitForFlag"/> for more information.
     10283        </desc>
    1019610284      </param>
    1019710285      <param name="timeoutMS" type="unsigned long" dir="in">
    10198         <desc>TODO</desc>
     10286        <desc>
     10287          Timeout (in ms) to wait for the operation to complete.
     10288          Pass 0 for an infinite timeout.
     10289        </desc>
    1019910290      </param>
    1020010291      <param name="reason" type="ProcessWaitResult" dir="return">
    10201         <desc>TODO</desc>
    10202       </param>
    10203     </method>
    10204    
     10292        <desc>
     10293          The overall wait result;
     10294          see <link to="ProcessWaitResult"/> for more information.
     10295        </desc>
     10296      </param>
     10297    </method>
     10298
    1020510299    <method name="read">
    1020610300      <desc>
    10207         TODO
    10208 
    10209         <result name="VBOX_E_NOT_SUPPORTED">
    10210           TODO
    10211         </result>
     10301        Reads data from a running process.
    1021210302      </desc>
    1021310303      <param name="handle" type="unsigned long" dir="in">
    10214         <desc>TODO</desc>
     10304        <desc>Handle to read from. Usually 0 is stdin.</desc>
    1021510305      </param>
    1021610306      <param name="size" type="unsigned long" dir="in">
    10217         <desc>TODO</desc>
     10307        <desc>Number of bytes to read.</desc>
    1021810308      </param>
    1021910309      <param name="timeoutMS" type="unsigned long" dir="in">
    10220         <desc>TODO</desc>
     10310        <desc>
     10311          Timeout (in ms) to wait for the operation to complete.
     10312          Pass 0 for an infinite timeout.
     10313        </desc>
    1022110314      </param>
    1022210315      <param name="data" type="octet" dir="return" safearray="yes">
    10223         <desc>TODO</desc>
    10224       </param>
    10225     </method>
    10226    
     10316        <desc>Array of data read.</desc>
     10317      </param>
     10318    </method>
     10319
    1022710320    <method name="write">
    1022810321      <desc>
    10229         TODO
    10230 
    10231         <result name="VBOX_E_NOT_SUPPORTED">
    10232           TODO
    10233         </result>
     10322        Writes data to a running process.
    1023410323      </desc>
    1023510324      <param name="handle" type="unsigned long" dir="in">
    10236         <desc>TODO</desc>
     10325        <desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
    1023710326      </param>
    1023810327      <param name="flags" type="unsigned long" dir="in">
    1023910328        <desc>
    10240           <link to="ProcessInputFlag"/> flags.
     10329          A combination of <link to="ProcessInputFlag"/> flags.
    1024110330        </desc>
    1024210331      </param>
    1024310332      <param name="data" type="octet" dir="in" safearray="yes">
    10244         <desc>TODO</desc>
     10333        <desc>
     10334          Array of bytes to write. The size of the array also specifies
     10335          how much to write.
     10336        </desc>
    1024510337      </param>
    1024610338      <param name="timeoutMS" type="unsigned long" dir="in">
    10247         <desc>TODO</desc>
     10339        <desc>
     10340          Timeout (in ms) to wait for the operation to complete.
     10341          Pass 0 for an infinite timeout.
     10342        </desc>
    1024810343      </param>
    1024910344      <param name="written" type="unsigned long" dir="return">
    10250         <desc>TODO</desc>
    10251       </param>
    10252     </method>
    10253    
    10254     <method name="WriteArray">
    10255       <desc>
    10256         TODO
    10257 
    10258         <result name="VBOX_E_NOT_SUPPORTED">
    10259           TODO
    10260         </result>
     10345        <desc>How much bytes were written.</desc>
     10346      </param>
     10347    </method>
     10348
     10349    <method name="writeArray">
     10350      <desc>
     10351        Writes data to a running process.
     10352        Scriptable version of <link to="#write" />.
    1026110353      </desc>
    1026210354      <param name="handle" type="unsigned long" dir="in">
    10263         <desc>TODO</desc>
     10355        <desc>Handle to write to. Usually 0 is stdin, 1 is stdout and 2 is stderr.</desc>
    1026410356      </param>
    1026510357      <param name="flags" type="ProcessInputFlag" dir="in" safearray="yes">
    1026610358        <desc>
    10267           <link to="ProcessInputFlag"/> flags.
     10359          A combination of <link to="ProcessInputFlag"/> flags.
    1026810360        </desc>
    1026910361      </param>
    1027010362      <param name="data" type="octet" dir="in" safearray="yes">
    10271         <desc>TODO</desc>
     10363        <desc>
     10364          Array of bytes to write. The size of the array also specifies
     10365          how much to write.
     10366        </desc>
    1027210367      </param>
    1027310368      <param name="timeoutMS" type="unsigned long" dir="in">
    10274         <desc>TODO</desc>
     10369        <desc>
     10370          Timeout (in ms) to wait for the operation to complete.
     10371          Pass 0 for an infinite timeout.
     10372        </desc>
    1027510373      </param>
    1027610374      <param name="written" type="unsigned long" dir="return">
    10277         <desc>TODO</desc>
    10278       </param>
    10279     </method>
    10280    
     10375        <desc>How much bytes were written.</desc>
     10376      </param>
     10377    </method>
     10378
    1028110379    <method name="terminate">
    1028210380      <desc>
    10283         TODO
    10284 
    10285         <result name="VBOX_E_NOT_SUPPORTED">
    10286           TODO
    10287         </result>
     10381        Terminates (kills) a running process.
    1028810382      </desc>
    1028910383    </method>
    1029010384  </interface>
    10291  
     10385
    1029210386  <interface
    1029310387    name="IGuestProcess" extends="IProcess"
    … …  
    1029610390    >
    1029710391    <desc>
    10298       TODO
     10392      Implementation of the <link to="IProcess" /> object
     10393      for processes on the guest.
    1029910394    </desc>
    1030010395  </interface>
    10301  
     10396
    1030210397  <interface
    1030310398    name="IDirectory" extends="$unknown"
    … …  
    1030610401    >
    1030710402    <desc>
    10308       TODO
     10403      Abstract parent interface for directories handled by VirtualBox.
    1030910404    </desc>
    10310    
     10405
    1031110406    <attribute name="directoryName" type="wstring" readonly="yes">
    1031210407      <desc>
    1031310408        Full path of directory.
    10314         <note>
    10315           TODO
    10316         </note>
    10317       </desc>
    10318     </attribute>
    10319    
     10409      </desc>
     10410    </attribute>
     10411
    1032010412    <attribute name="filter" type="wstring" readonly="yes">
    1032110413      <desc>
    1032210414        The open filter.
    10323         <note>
    10324           TODO
    10325         </note>
    10326       </desc>
    10327     </attribute>
    10328    
     10415      </desc>
     10416    </attribute>
     10417
    1032910418    <method name="close">
    1033010419      <desc>
    10331         TODO
    10332 
    10333         <result name="VBOX_E_NOT_SUPPORTED">
    10334           TODO
    10335         </result>
    10336       </desc>
    10337     </method>
    10338    
     10420        Closes this directory. After closing operations like reading the next
     10421        directory entry will not be possible anymore.
     10422      </desc>
     10423    </method>
     10424
    1033910425    <method name="read">
    1034010426      <desc>
    10341         TODO
    10342 
     10427        Reads the next directory entry of this directory.
    1034310428        <result name="VBOX_E_OBJECT_NOT_FOUND">
    10344           End of directory listing reached.
     10429          No more directory entries to read.
    1034510430        </result>
    1034610431      </desc>
    1034710432      <param name="objInfo" type="IFsObjInfo" dir="return">
    10348         <desc>TODO</desc>
     10433        <desc>Object information of the current directory entry read. Also see  <link to="IFsObjInfo"/>.</desc>
    1034910434      </param>
    1035010435    </method>
    1035110436  </interface>
    10352  
     10437
    1035310438  <interface
    1035410439    name="IGuestDirectory" extends="IDirectory"
    … …  
    1035710442    >
    1035810443    <desc>
    10359       TODO
     10444      Implementation of the <link to="IDirectory" /> object
     10445      for directories on the guest.
    1036010446    </desc>
    1036110447  </interface>
    10362    
     10448
    1036310449  <interface
    1036410450    name="IFile" extends="$unknown"
    … …  
    1036710453    >
    1036810454    <desc>
    10369       TODO
     10455      Abstract parent interface for files handled by VirtualBox.
    1037010456    </desc>
    1037110457    <attribute name="creationMode" type="unsigned long" readonly="yes">
    1037210458      <desc>
    10373         TODO
    10374         <note>
    10375           TODO
    10376         </note>
     10459        The creation mode.
     10460
     10461        <result name="E_NOTIMPL">
     10462          The method is not implemented yet.
     10463         </result>
    1037710464      </desc>
    1037810465    </attribute>
    1037910466    <attribute name="disposition" type="unsigned long" readonly="yes">
    1038010467      <desc>
    10381         TODO
    10382         <note>
    10383           TODO
    10384         </note>
     10468        The disposition mode.
     10469
     10470        <result name="E_NOTIMPL">
     10471          The method is not implemented yet.
     10472        </result>
    1038510473      </desc>
    1038610474    </attribute>
    1038710475    <attribute name="fileName" type="wstring" readonly="yes">
    1038810476      <desc>
    10389         TODO
    10390         <note>
    10391           TODO
    10392         </note>
     10477        Full path of the actual file name of this file.
    1039310478      </desc>
    1039410479    </attribute>
    1039510480    <attribute name="initialSize" type="long long" readonly="yes">
    1039610481      <desc>
    10397         TODO
    10398         <note>
    10399           TODO
    10400         </note>
     10482        The initial size in bytes when opened.
     10483
     10484        <result name="E_NOTIMPL">
     10485          The method is not implemented yet.
     10486        </result>
    1040110487      </desc>
    1040210488    </attribute>
    1040310489    <attribute name="openMode" type="unsigned long" readonly="yes">
    1040410490      <desc>
    10405         TODO
    10406         <note>
    10407           TODO
    10408         </note>
     10491        The open mode.
     10492
     10493        <result name="E_NOTIMPL">
     10494          The method is not implemented yet.
     10495        </result>
    1040910496      </desc>
    1041010497    </attribute>
    1041110498    <attribute name="offset" type="long long" readonly="yes">
    1041210499      <desc>
    10413         TODO
    10414         <note>
    10415           TODO
    10416         </note>
    10417       </desc>
    10418     </attribute>
    10419    
     10500        Current read/write offset in bytes.
     10501
     10502        <result name="E_NOTIMPL">
     10503          The method is not implemented yet.
     10504        </result>
     10505      </desc>
     10506    </attribute>
     10507
    1042010508    <method name="close">
    1042110509      <desc>
    10422         TODO
    10423 
    10424         <result name="VBOX_E_NOT_SUPPORTED">
    10425           TODO
    10426         </result>
    10427       </desc>
    10428     </method>
    10429    
     10510        Closes this file. After closing operations like reading data,
     10511        writing data or querying information will not be possible anymore.
     10512
     10513        <result name="E_NOTIMPL">
     10514          The method is not implemented yet.
     10515        </result>
     10516      </desc>
     10517    </method>
     10518
    1043010519    <method name="queryInfo">
    1043110520      <desc>
    10432         TODO
    10433 
    10434         <result name="VBOX_E_NOT_SUPPORTED">
    10435           TODO
     10521        Queries information about this file.
     10522
     10523        <result name="E_NOTIMPL">
     10524          The method is not implemented yet.
    1043610525        </result>
    1043710526      </desc>
    1043810527      <param name="objInfo" type="IFsObjInfo" dir="return">
    10439         <desc>TODO</desc>
    10440       </param>
    10441     </method> 
    10442        
     10528        <desc>Object information of this file. Also see  <link to="IFsObjInfo"/>.</desc>
     10529      </param>
     10530    </method>
     10531
    1044310532    <method name="read">
    1044410533      <desc>
    10445         TODO
    10446 
    10447         <result name="VBOX_E_NOT_SUPPORTED">
    10448           TODO
     10534        Reads data from this file.
     10535
     10536        <result name="E_NOTIMPL">
     10537          The method is not implemented yet.
    1044910538        </result>
    1045010539      </desc>
    1045110540      <param name="toRead" type="unsigned long" dir="in">
    10452         <desc>TODO</desc>
     10541        <desc>Number of bytes to read.</desc>
    1045310542      </param>
    1045410543      <param name="read" type="unsigned long" dir="out">
    10455         <desc>TODO</desc>
     10544        <desc>How much bytes were read.</desc>
    1045610545      </param>
    1045710546      <param name="data" type="octet" dir="return" safearray="yes">
    10458         <desc>TODO</desc>
    10459       </param>
    10460     </method>
    10461        
     10547        <desc>Array of data read.</desc>
     10548      </param>
     10549    </method>
     10550
    1046210551    <method name="readAt">
    1046310552      <desc>
    10464         TODO
    10465 
    10466         <result name="VBOX_E_NOT_SUPPORTED">
    10467           TODO
     10553        Reads data from an offset of this file.
     10554
     10555        <result name="E_NOTIMPL">
     10556          The method is not implemented yet.
    1046810557        </result>
    1046910558      </desc>
    1047010559      <param name="offset" type="long long" dir="in">
    10471         <desc>TODO</desc>
     10560        <desc>Offset in bytes to start reading.</desc>
    1047210561      </param>
    1047310562      <param name="toRead" type="unsigned long" dir="in">
    10474         <desc>TODO</desc>
     10563        <desc>Number of bytes to read.</desc>
    1047510564      </param>
    1047610565      <param name="read" type="unsigned long" dir="out">
    10477         <desc>TODO</desc>
     10566        <desc>How much bytes were read.</desc>
    1047810567      </param>
    1047910568      <param name="data" type="octet" dir="return" safearray="yes">
    10480         <desc>TODO</desc>
    10481       </param>
    10482     </method>
    10483    
     10569        <desc>Array of data read.</desc>
     10570      </param>
     10571    </method>
     10572
    1048410573    <method name="seek">
    1048510574      <desc>
    10486         TODO
    10487 
    10488         <result name="VBOX_E_NOT_SUPPORTED">
    10489           TODO
     10575        Changes the read and write position of this file.
     10576
     10577        <result name="E_NOTIMPL">
     10578          The method is not implemented yet.
    1049010579        </result>
    1049110580      </desc>
    1049210581      <param name="offset" type="long long" dir="in">
    10493         <desc>TODO</desc>
     10582        <desc>Offset to seek.</desc>
    1049410583      </param>
    1049510584      <param name="whence" type="FileSeekType" dir="in">
    10496         <desc>TODO</desc>
    10497       </param>
    10498     </method>
    10499    
     10585        <desc>
     10586          Seek mode; see <link to="FileSeekType"/> for more information.
     10587        </desc>
     10588      </param>
     10589    </method>
     10590
    1050010591    <method name="setACL">
    1050110592      <desc>
    10502         TODO
    10503 
    10504         <result name="VBOX_E_NOT_SUPPORTED">
    10505           TODO
     10593        Sets the ACL of this file.
     10594
     10595        <result name="E_NOTIMPL">
     10596          The method is not implemented yet.
    1050610597        </result>
    1050710598      </desc>
    1050810599      <param name="acl" type="wstring" dir="in">
    10509         <desc>TODO</desc>
    10510       </param>
    10511     </method>
    10512    
     10600        <desc>ACL string to set.</desc>
     10601      </param>
     10602    </method>
     10603
    1051310604    <method name="write">
    1051410605      <desc>
    10515         TODO
    10516 
    10517         <result name="VBOX_E_NOT_SUPPORTED">
    10518           TODO
    10519         </result>
     10606        Writes bytes to this file.
    1052010607      </desc>
    1052110608      <param name="data" type="octet" dir="in" safearray="yes">
    10522         <desc>TODO</desc>
     10609        <desc>
     10610          Array of bytes to write. The size of the array also specifies
     10611          how much to write.
     10612        </desc>
    1052310613      </param>
    1052410614      <param name="written" type="unsigned long" dir="return">
    10525         <desc>TODO</desc>
    10526       </param>
    10527     </method>
    10528    
     10615        <desc>How much bytes were written.</desc>
     10616      </param>
     10617    </method>
     10618
    1052910619    <method name="writeAt">
    1053010620      <desc>
    10531         TODO
    10532 
    10533         <result name="VBOX_E_NOT_SUPPORTED">
    10534           TODO
     10621        Writes bytes at a certain offset to this file.
     10622
     10623        <result name="E_NOTIMPL">
     10624          The method is not implemented yet.
    1053510625        </result>
    1053610626      </desc>
    1053710627      <param name="offset" type="long long" dir="in">
    10538         <desc>TODO</desc>
     10628        <desc>Offset in bytes to start writing.</desc>
    1053910629      </param>
    1054010630      <param name="data" type="octet" dir="in" safearray="yes">
    10541         <desc>TODO</desc>
     10631        <desc>
     10632          Array of bytes to write. The size of the array also specifies
     10633          how much to write.
     10634        </desc>
    1054210635      </param>
    1054310636      <param name="written" type="unsigned long" dir="return">
    10544         <desc>TODO</desc>
     10637        <desc>How much bytes were written.</desc>
    1054510638      </param>
    1054610639    </method>
    1054710640
    1054810641  </interface>
    10549  
     10642
    1055010643  <interface
    1055110644    name="IGuestFile" extends="IFile"
    … …  
    1055410647    >
    1055510648    <desc>
    10556       TODO
     10649      Implementation of the <link to="IFile" /> object
     10650      for files on the guest.
    1055710651    </desc>
    1055810652  </interface>
    10559  
     10653
    1056010654  <interface
    1056110655    name="IFsObjInfo" extends="$unknown"
    … …  
    1056410658    >
    1056510659    <desc>
    10566       TODO
     10660      Abstract parent interface for VirtualBox file system object information.
     10661      This can be information about a file or a directory, for example.
    1056710662    </desc>
    10568    
     10663
    1056910664    <attribute name="accessTime" type="long long" readonly="yes">
    1057010665      <desc>
    10571         TODO
    10572         <note>
    10573           TODO
    10574         </note>
     10666        Time of last access (st_atime).
    1057510667      </desc>
    1057610668    </attribute>
    1057710669    <attribute name="allocatedSize" type="long long" readonly="yes">
    1057810670      <desc>
    10579         TODO
    10580         <note>
    10581           TODO
    10582         </note>
     10671        Disk allocation size (st_blocks * DEV_BSIZE).
    1058310672      </desc>
    1058410673    </attribute>
    1058510674    <attribute name="birthTime" type="long long" readonly="yes">
    1058610675      <desc>
    10587         TODO
    10588         <note>
    10589           TODO
    10590         </note>
     10676        Time of file birth (st_birthtime).
    1059110677      </desc>
    1059210678    </attribute>
    1059310679        <attribute name="changeTime" type="long long" readonly="yes">
    1059410680      <desc>
    10595         TODO
    10596         <note>
    10597           TODO
    10598         </note>
     10681        Time of last status change (st_ctime).
    1059910682      </desc>
    1060010683    </attribute>
    1060110684    <attribute name="deviceNumber" type="unsigned long" readonly="yes">
    1060210685      <desc>
    10603         TODO
    10604         <note>
    10605           TODO
    10606         </note>
     10686        The device number of a character or block device type object (st_rdev).
    1060710687      </desc>
    1060810688    </attribute>
    1060910689    <attribute name="fileAttributes" type="wstring" readonly="yes">
    1061010690      <desc>
    10611         TODO
    10612         <note>
    10613           TODO
    10614         </note>
     10691        File attributes. Not implemented yet.
    1061510692      </desc>
    1061610693    </attribute>
    1061710694    <attribute name="generationId" type="unsigned long" readonly="yes">
    1061810695      <desc>
    10619         TODO
    10620         <note>
    10621           TODO
    10622         </note>
     10696        The current generation number (st_gen).
    1062310697      </desc>
    1062410698    </attribute>
    1062510699    <attribute name="GID" type="unsigned long" readonly="yes">
    1062610700      <desc>
    10627         TODO
    10628         <note>
    10629           TODO
    10630         </note>
     10701        The group the filesystem object is assigned (st_gid).
    1063110702      </desc>
    1063210703    </attribute>
    1063310704    <attribute name="groupName" type="wstring" readonly="yes">
    1063410705      <desc>
    10635         TODO
    10636         <note>
    10637           TODO
    10638         </note>
     10706        The group name.
    1063910707      </desc>
    1064010708    </attribute>
    1064110709    <attribute name="hardLinks" type="unsigned long" readonly="yes">
    1064210710      <desc>
    10643         TODO
    10644         <note>
    10645           TODO
    10646         </note>
     10711        Number of hard links to this filesystem object (st_nlink).
    1064710712      </desc>
    1064810713    </attribute>
    1064910714    <attribute name="modificationTime" type="long long" readonly="yes">
    1065010715      <desc>
    10651         TODO
    10652         <note>
    10653           TODO
    10654         </note>
     10716        Time of last data modification (st_mtime).
    1065510717      </desc>
    1065610718    </attribute>
    1065710719    <attribute name="name" type="wstring" readonly="yes">
    1065810720      <desc>
    10659         TODO
    10660         <note>
    10661           TODO
    10662         </note>
     10721        The object's name.
    1066310722      </desc>
    1066410723    </attribute>
    1066510724    <attribute name="nodeId" type="long long" readonly="yes">
    1066610725      <desc>
    10667         TODO
    10668         <note>
    10669           TODO
    10670         </note>
     10726        The unique identifier (within the filesystem) of this filesystem object (st_ino).
    1067110727      </desc>
    1067210728    </attribute>
    1067310729    <attribute name="nodeIdDevice" type="unsigned long" readonly="yes">
    1067410730      <desc>
    10675         TODO
    10676         <note>
    10677           TODO
    10678         </note>
    10679       </desc>
    10680     </attribute>     
     10731        The device number of the device which this filesystem object resides on (st_dev).
     10732      </desc>
     10733    </attribute>
    1068110734    <attribute name="objectSize" type="long long" readonly="yes">
    1068210735      <desc>
    10683         TODO
    10684         <note>
    10685           TODO
    10686         </note>
     10736        The logical size (st_size). For normal files this is the size of the file.
     10737        For symbolic links, this is the length of the path name contained in the
     10738        symbolic link. For other objects this fields needs to be specified.
    1068710739      </desc>
    1068810740    </attribute>
    1068910741    <attribute name="type" type="FsObjType" readonly="yes">
    1069010742      <desc>
    10691         TODO
    10692         <note>
    10693           TODO
    10694         </note>
    10695       </desc>
    10696     </attribute>     
     10743        The object type. See <link to="FsObjType" /> for more.
     10744      </desc>
     10745    </attribute>
    1069710746    <attribute name="UID" type="unsigned long" readonly="yes">
    1069810747      <desc>
    10699         TODO
    10700         <note>
    10701           TODO
    10702         </note>
     10748        The user owning the filesystem object (st_uid).
    1070310749      </desc>
    1070410750    </attribute>
    1070510751    <attribute name="userFlags" type="unsigned long" readonly="yes">
    1070610752      <desc>
    10707         TODO
    10708         <note>
    10709           TODO
    10710         </note>
     10753        User flags (st_flags).
    1071110754      </desc>
    1071210755    </attribute>
    1071310756    <attribute name="userName" type="wstring" readonly="yes">
    1071410757      <desc>
    10715         TODO
    10716         <note>
    10717           TODO
    10718         </note>
    10719       </desc>
    10720     </attribute> 
    10721    
     10758        The user name.
     10759      </desc>
     10760    </attribute>
     10761
    1072210762  </interface>
    10723  
     10763
    1072410764  <interface
    1072510765    name="IGuestFsObjInfo" extends="IFsObjInfo"
    … …  
    1072810768    >
    1072910769    <desc>
    10730       TODO
     10770      Represents the guest implementation of the
     10771      <link to="IFsObjInfo" /> object.
    1073110772    </desc>
    1073210773  </interface>
    10733  
     10774
    1073410775  <interface
    1073510776    name="IGuest" extends="$unknown"
    … …  
    1079010831
    1079110832    <attribute name="sessions" type="IGuestSession" readonly="yes" safearray="yes">
    10792       <desc>TODO</desc>
    10793     </attribute>
    10794    
     10833      <desc>Returns a collection of all opened guest sessions.</desc>
     10834    </attribute>
     10835
    1079510836    <attribute name="memoryBalloonSize" type="unsigned long">
    1079610837      <desc>Guest system memory balloon size in megabytes (transient property).</desc>
    … …  
    1112411165    <method name="createSession">
    1112511166      <desc>
    11126         TODO
     11167        Creates a new guest session for controlling the guest. All operations
     11168        of a session object are using the same credentials specified with this
     11169        call. Anonymous sessions, that is, sessions without specifying a valid
     11170        user account on the guest are not allowed due to security reasons. Per
     11171        VM there can be 255 sessions at once. Using sessions across VMs is not
     11172        possible.
     11173
     11174        A guest session holds all started or opened guest processes, guest
     11175        directories and guest files.
     11176
     11177        Closing a session via <link to="IGuestSession::close" /> will try to close
     11178        all the mentioned objects above unless these objects are still used by
     11179        a client.
    1112711180      </desc>
    1112811181      <param name="user" type="wstring" dir="in">
    1112911182        <desc>
    11130           TODO
     11183          User name this session will be using to control the guest; has to exist
     11184          and have the appropriate rights to execute programs in the VM. Must not
     11185          be empty.
    1113111186        </desc>
    1113211187      </param>
    1113311188      <param name="password" type="wstring" dir="in">
    1113411189        <desc>
    11135           TODO
     11190          Password of the user account to be used. Empty passwords are allowed.
    1113611191        </desc>
    1113711192      </param>
    1113811193      <param name="domain" type="wstring" dir="in">
    1113911194        <desc>
    11140           TODO
     11195          Domain name of the user account to be used if the guest is part of
     11196          a domain. Optional. This feature is not implemented yet.
    1114111197        </desc>
    1114211198      </param>
    1114311199      <param name="sessionName" type="wstring" dir="in">
    1114411200        <desc>
    11145           TODO
     11201          The session's friendly name. Optional, can be empty.
    1114611202        </desc>
    1114711203      </param>
    1114811204      <param name="guestSession" type="IGuestSession" dir="return">
    1114911205        <desc>
    11150           TODO
    11151         </desc>
    11152       </param>
    11153     </method>
    11154    
     11206          The newly created session object.
     11207        </desc>
     11208      </param>
     11209    </method>
     11210
    1115511211    <method name="findSession">
    1115611212      <desc>
    11157         TODO
    11158       </desc>     
     11213        Finds guest sessions by their friendly name and returns an interface
     11214        array with all found guest sessions.
     11215      </desc>
    1115911216      <param name="sessionName" type="wstring" dir="in">
    1116011217        <desc>
    11161           TODO
     11218          The session's friendly name to find. Wildcards like ? and * are allowed.
    1116211219        </desc>
    1116311220      </param>
    1116411221      <param name="sessions" type="IGuestSession" safearray="yes" dir="return">
    1116511222        <desc>
    11166           TODO
    11167         </desc>
    11168       </param>
    11169     </method>
    11170    
     11223          Array with all guest sessions found matching the name specified.
     11224        </desc>
     11225      </param>
     11226    </method>
     11227
    1117111228    <method name="executeProcess">
    1117211229      <desc>
    … …  
    1364213699
    1364313700    The @a parent argument defines which medium will be the parent
    13644     of the clone. In this case the clone will be a base image, i.e. 
    13645     completely independent. It is possible to specify an arbitrary 
     13701    of the clone. In this case the clone will be a base image, i.e.
     13702    completely independent. It is possible to specify an arbitrary
    1364613703    medium for this parameter, including the parent of the
    1364713704    medium which is being cloned. Even cloning to a child of the source
    … …  
    1696217019      </param>
    1696317020    </method>
    16964    
     17021
    1696517022    <method name="onClipboardModeChange">
    1696617023      <desc>
注意: 瀏覽 TracChangeset 來幫助您使用更動檢視器

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