Changeset 99150 in vbox for trunk/src/VBox/Main/idl
- Timestamp:
- Mar 23, 2023 6:00:47 PM (2 years ago)
- svn:sync-xref-src-repo-rev:
- 156515
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/VBox/Main/idl/VirtualBox.xidl
r99120 r99150 14814 14814 <interface 14815 14815 name="IGuestSession" extends="$unknown" 14816 uuid="5 591bead-9c1d-4cbd-9669-2d0b04fac0a8"14816 uuid="5e54f60b-6dcd-4594-a6c9-cf968f004341" 14817 14817 wsmap="managed" 14818 14818 reservedMethods="8" reservedAttributes="12" … … 15966 15966 </desc> 15967 15967 </param> 15968 <param name="cwd" type="wstring" dir="in">15969 <desc>15970 Path to the directory in which to execute in the guest. The15971 directory has to exist in the guest VM with search rights to the15972 session user in order to succeed. If empty/null, the session15973 user's default (typically 'home') directory is used. If not a15974 full path, it is interpreted relative to the default directory;15975 e.g. 'work' means '$HOME/work' (according to the guest's '$HOME'-15976 like concept).15977 </desc>15978 </param>15979 15968 <param name="arguments" type="wstring" dir="in" safearray="yes"> 15980 15969 <desc>Array of arguments passed to the new process. … … 15988 15977 </desc> 15989 15978 </param> 15990 <param name="environmentChanges" type="wstring" dir="in" safearray="yes">15991 <desc>15992 Set of environment changes to complement15993 <link to="IGuestSession::environmentChanges"/>. Takes precedence15994 over the session ones. The changes are in putenv format, i.e.15995 "VAR=VALUE" for setting and "VAR" for unsetting.15996 15997 The changes are applied to the base environment of the impersonated15998 guest user (<link to="IGuestSession::environmentBase"/>) when15999 creating the process. (This is done on the guest side of things in16000 order to be compatible with older Guest Additions. That is one of16001 the motivations for not passing in the whole environment here.)16002 </desc>16003 </param>16004 <param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes">16005 <desc>16006 Process creation flags;16007 see <link to="ProcessCreateFlag"/> for more information.16008 </desc>16009 </param>16010 <param name="timeoutMS" type="unsigned long" dir="in">16011 <desc>16012 Timeout (in ms) for limiting the guest process' running time.16013 Pass 0 for an infinite timeout. On timeout the guest process will be16014 killed and its status will be put to an appropriate value. See16015 <link to="ProcessStatus"/> for more information.16016 </desc>16017 </param>16018 <param name="guestProcess" type="IGuestProcess" dir="return">16019 <desc>Guest process object of the newly created process.</desc>16020 </param>16021 </method>16022 16023 <method name="processCreateEx">16024 <desc>16025 Creates a new process running in the guest with the extended options16026 for setting the process priority and affinity.16027 16028 See <link to="IGuestSession::processCreate"/> for more information.16029 </desc>16030 15979 <param name="cwd" type="wstring" dir="in"> 16031 15980 <desc> … … 16039 15988 </desc> 16040 15989 </param> 15990 <param name="environmentChanges" type="wstring" dir="in" safearray="yes"> 15991 <desc> 15992 Set of environment changes to complement 15993 <link to="IGuestSession::environmentChanges"/>. Takes precedence 15994 over the session ones. The changes are in putenv format, i.e. 15995 "VAR=VALUE" for setting and "VAR" for unsetting. 15996 15997 The changes are applied to the base environment of the impersonated 15998 guest user (<link to="IGuestSession::environmentBase"/>) when 15999 creating the process. (This is done on the guest side of things in 16000 order to be compatible with older Guest Additions. That is one of 16001 the motivations for not passing in the whole environment here.) 16002 </desc> 16003 </param> 16004 <param name="flags" type="ProcessCreateFlag" dir="in" safearray="yes"> 16005 <desc> 16006 Process creation flags; 16007 see <link to="ProcessCreateFlag"/> for more information. 16008 </desc> 16009 </param> 16010 <param name="timeoutMS" type="unsigned long" dir="in"> 16011 <desc> 16012 Timeout (in ms) for limiting the guest process' running time. 16013 Pass 0 for an infinite timeout. On timeout the guest process will be 16014 killed and its status will be put to an appropriate value. See 16015 <link to="ProcessStatus"/> for more information. 16016 </desc> 16017 </param> 16018 <param name="guestProcess" type="IGuestProcess" dir="return"> 16019 <desc>Guest process object of the newly created process.</desc> 16020 </param> 16021 </method> 16022 16023 <method name="processCreateEx"> 16024 <desc> 16025 Creates a new process running in the guest with the extended options 16026 for setting the process priority and affinity. 16027 16028 See <link to="IGuestSession::processCreate"/> for more information. 16029 </desc> 16041 16030 <param name="executable" type="wstring" dir="in"> 16042 16031 <desc> … … 16056 16045 <link to="IGuestSession::protocolVersion"/> is 3 or higher. 16057 16046 </note> 16047 </desc> 16048 </param> 16049 <param name="cwd" type="wstring" dir="in"> 16050 <desc> 16051 Path to the directory in which to execute in the guest. The 16052 directory has to exist in the guest VM with search rights to the 16053 session user in order to succeed. If empty/null, the session 16054 user's default (typically 'home') directory is used. If not a 16055 full path, it is interpreted relative to the default directory; 16056 e.g. 'work' means '$HOME/work' (according to the guest's '$HOME'- 16057 like concept). 16058 16058 </desc> 16059 16059 </param>
Note:
See TracChangeset
for help on using the changeset viewer.