VirtualBox

Changeset 55639 in vbox for trunk/doc


Ignore:
Timestamp:
May 4, 2015 12:32:06 PM (10 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
100014
Message:

SDKRef.xml: List incompatible IGuestSession, IGuestProcess and IGuestFile changes.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/manual/en_US/SDKRef.xml

    r55631 r55639  
    40404040
    40414041          </itemizedlist></para>
     4042        </listitem>
     4043
     4044        <listitem><para>IGuestSession, IGuestFile and IGuestProcess interfaces were changed as follows:
     4045          <itemizedlist>
     4046            <listitem>
     4047              <para>Replaced IGuestSession::directoryQueryInfo and IGuestSession::fileQueryInfo with a new
     4048                 <xref linkend="IGuestSession__fsObjQueryInfo" xreflabel="IGuestSession::fsObjQueryInfo"/> method
     4049                 that works on any type of file system object.</para>
     4050            </listitem>
     4051            <listitem>
     4052              <para>Replaced IGuestSession::fileRemove, IGuestSession::symlinkRemoveDirectory and
     4053                 IGuestSession::symlinkRemoveFile with a new
     4054                 <xref linkend="IGuestSession__fsObjRemove" xreflabel="IGuestSession::fsObjRemove"/> method that works
     4055                 on any type of file system object except directories. (fileRemove also worked on any type of object too,
     4056                 though that was not the intent of the method.)</para>
     4057            </listitem>
     4058            <listitem>
     4059              <para>Replaced IGuestSession::directoryRename and IGuestSession::directoryRename with a new
     4060                 <xref linkend="IGuestSession__fsObjRename" xreflabel="IGuestSession::fsObjRename"/> method that works
     4061                 on any type of file system object. (directoryRename and fileRename may already have worked for any kind
     4062                 of object, but that was never the intent of the methods.)</para>
     4063            </listitem>
     4064            <listitem>
     4065              <para>Replaced the unimplemented IGuestSession::directorySetACL and IGuestSession::fileSetACL with a new
     4066                 <xref linkend="IGuestSession__fsObjSetACL" xreflabel="IGuestSession::fsObjSetACL"/> method that works
     4067                 on all type of file system object. Also added a UNIX-style mode parameter as an alternative to the ACL.</para>
     4068            </listitem>
     4069            <listitem>
     4070              <para>Replaced IGuestSession::fileRemove, IGuestSession::symlinkRemoveDirectory and
     4071                 IGuestSession::symlinkRemoveFile with a new
     4072                 <xref linkend="IGuestSession__fsObjRemove" xreflabel="IGuestSession::fsObjRemove"/> method that works
     4073                 on any type of file system object except directories (fileRemove also worked on any type of object,
     4074                 though that was not the intent of the method.)</para>
     4075            </listitem>
     4076            <listitem>
     4077              <para>Renamed IGuestSession::copyTo to <xref linkend="IGuestSession__fileCopyToGuest"
     4078                 xreflabel="IGuestSession::fileCopyToGuest"/>.</para>
     4079            </listitem>
     4080            <listitem>
     4081              <para>Renamed IGuestSession::copyFrom to <xref linkend="IGuestSession__fileCopyFromGuest"
     4082                 xreflabel="IGuestSession::fileCopyFromGuest"/>.</para>
     4083            </listitem>
     4084            <listitem>
     4085              <para>Renamed the CopyFileFlag enum to <xref linkend="FileCopyFlag" xreflabel="FileCopyFlag"/>.</para>
     4086            </listitem>
     4087            <listitem>
     4088              <para>Renamed the IGuestSession::environment attribute to <xref linkend="IGuestSession__environmentChanges"
     4089                xreflabel="IGuestSession::environmentChanges"/> to better reflect what it does.</para>
     4090            </listitem>
     4091            <listitem>
     4092              <para>Changed the <xref linkend="IProcess__environment" xreflabel="IGuestProcess::environment"/> to
     4093               a stub returning E_NOTIMPL since it wasn't doing what was advertised (returned changes, not the
     4094               actual environment).</para>
     4095            </listitem>
     4096            <listitem>
     4097              <para>Renamed IGuestSession::environmentSet to <xref linkend="IGuestSession__environmentScheduleSet"
     4098                xreflabel="IGuestSession::environmentScheduleSet"/> to better reflect what it does.</para>
     4099            </listitem>
     4100            <listitem>
     4101              <para>Renamed IGuestSession::environmentUnset to <xref linkend="IGuestSession__environmentScheduleUnset"
     4102                xreflabel="IGuestSession::environmentScheduleUnset"/> to better reflect what it does.</para>
     4103            </listitem>
     4104            <listitem>
     4105              <para>Removed IGuestSession::environmentGet it was only getting changes while giving the impression it was
     4106                actual environment variables, and it did not represent scheduled unset operations.</para>
     4107            </listitem>
     4108            <listitem>
     4109              <para>Removed IGuestSession::environmentClear as it duplicates assigning an empty array to the
     4110                <xref linkend="IGuestSession__environmentChanges" xreflabel="IGuestSession::environmentChanges"/> (formerly
     4111                known as IGuestSession::environment).</para>
     4112            </listitem>
     4113            <listitem>
     4114              <para>Changed the <xref linkend="IGuestSession__processCreate" xreflabel="IGuestSession::processCreate"/> and
     4115              <xref linkend="IGuestSession__processCreateEx" xreflabel="IGuestSession::processCreateEx"/> methods to accept
     4116              arguments starting with argument zero (argv[0]) instead of argument one (argv[1]). (Not yet implemented on the
     4117              guest additions side, so argv[0] will probably be ignored for a short while.)</para>
     4118            </listitem>
     4119
     4120            <listitem>
     4121              <para>Added a followSymlink parameter to the following methods:<itemizedlist>
     4122                <listitem><para><xref linkend="IGuestSession__directoryExists"
     4123                  xreflabel="IGuestSession::directoryExists"/></para></listitem>
     4124                <listitem><para><xref linkend="IGuestSession__fileExists"
     4125                  xreflabel="IGuestSession::fileExists"/></para></listitem>
     4126                <listitem><para><xref linkend="IGuestSession__fileQuerySize"
     4127                  xreflabel="IGuestSession::fileQuerySize"/></para></listitem>
     4128              </itemizedlist></para>
     4129            </listitem>
     4130            <listitem>
     4131              <para>The parameters to the <xref linkend="IGuestSession__fileOpen" xreflabel="IGuestSession::fileOpen"/>
     4132                and <xref linkend="IGuestSession__fileOpenEx" xreflabel="IGuestSession::fileOpenEx"/> methods were
     4133                altered:<itemizedlist>
     4134                <listitem><para>The openMode string parameter was replaced by the enum
     4135                  <xref linkend="FileAccessMode" xreflabel="FileAccessMode"/> and renamed to accessMode.</para></listitem>
     4136                <listitem><para>The disposition string parameter was replaced by the enum
     4137                  <xref linkend="FileOpenAction" xreflabel="FileOpenAction"/> and renamed to openAction.</para></listitem>
     4138                <listitem><para>The unimplemented sharingMode string parameter was replaced by the enum
     4139                  <xref linkend="FileSharingMode" xreflabel="FileSharingMode"/> (fileOpenEx only).</para></listitem>
     4140              </itemizedlist></para>
     4141            </listitem>
     4142
     4143            <listitem>
     4144              <para><xref linkend="IFile__seek" xreflabel="IGuestFile::seek"/> now returns the new offset.</para>
     4145            </listitem>
     4146            <listitem>
     4147              <para>Renamed the FileSeekType enum used by <xref linkend="IFile__seek" xreflabel="IGuestFile::seek"/>
     4148                to <xref linkend="FileSeekOrigin" xreflabel="FileSeekOrigin"/> and added the missing End value.</para>
     4149            </listitem>
     4150            <listitem>
     4151              <para>Extended the unimplemented <xref linkend="IFile__setACL" xreflabel="IGuestFile::setACL"/>
     4152                method with a UNIX-style mode parameter as an alternative to the ACL.</para>
     4153            </listitem>
     4154            <listitem>
     4155              <para>Renamed the IFile::openMode attribute to <xref linkend="IFile__accessMode" xreflabel="IFile::accessMode"/>
     4156                and change the type from string to <xref linkend="FileAccessMode" xreflabel="FileAccessMode"/> to reflect
     4157                the changes to the fileOpen methods.</para>
     4158            </listitem>
     4159            <listitem>
     4160              <para>Renamed the IGuestFile::disposition attribute to <xref linkend="IFile__openAction"
     4161                xreflabel="IFile::openAction"/> and change the type from string to <xref linkend="FileOpenAction"
     4162                xreflabel="FileOpenAction"/> to reflect the changes to the fileOpen methods.</para>
     4163            </listitem>
     4164
     4165            <!-- Non-incompatible things worth mentioning (stubbed methods/attrs aren't worth it). -->
     4166            <listitem>
     4167              <para>Added <xref linkend="IGuestSession__pathStyle" xreflabel="IGuestSession::pathStyle"/> attribute.</para>
     4168            </listitem>
     4169            <listitem>
     4170              <para>Added <xref linkend="IGuestSession__fsObjExists" xreflabel="IGuestSession::fsObjExists"/> attribute.</para>
     4171            </listitem>
     4172
     4173          </itemizedlist>
     4174          </para>
    40424175        </listitem>
    40434176
Note: See TracChangeset for help on using the changeset viewer.

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