VirtualBox

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


Ignore:
Timestamp:
Dec 9, 2008 8:41:26 AM (16 years ago)
Author:
vboxsync
Message:

#3285: Improve error handling API to include unique error numbers
Document IMachine interface, part II.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r15067 r15140  
    37753775        Returns the network adapter associated with the given slot.
    37763776        Slots are numbered sequentially, starting with zero. The total
    3777         number of adapters per every machine is defined by the
     3777        number of adapters per machine is defined by the
    37783778        <link to="ISystemProperties::networkAdapterCount"/> property,
    37793779        so the maximum slot number is one less than that property's value.
     3780
     3781        <result name="E_INVALIDARG">
     3782          Invalid @a slot number.
     3783        </result>
     3784
    37803785      </desc>
    37813786      <param name="slot" type="unsigned long" dir="in"/>
    … …  
    37873792        Returns the serial port associated with the given slot.
    37883793        Slots are numbered sequentially, starting with zero. The total
    3789         number of serial ports per every machine is defined by the
     3794        number of serial ports per machine is defined by the
    37903795        <link to="ISystemProperties::serialPortCount"/> property,
    37913796        so the maximum slot number is one less than that property's value.
     3797
     3798        <result name="E_INVALIDARG">
     3799          Invalid @a slot number.
     3800        </result>
     3801
    37923802      </desc>
    37933803      <param name="slot" type="unsigned long" dir="in"/>
    … …  
    37993809        Returns the parallel port associated with the given slot.
    38003810        Slots are numbered sequentially, starting with zero. The total
    3801         number of parallel ports per every machine is defined by the
     3811        number of parallel ports per machine is defined by the
    38023812        <link to="ISystemProperties::parallelPortCount"/> property,
    38033813        so the maximum slot number is one less than that property's value.
     3814
     3815        <result name="E_INVALIDARG">
     3816          Invalid @a slot number.
     3817        </result>
     3818
    38043819      </desc>
    38053820      <param name="slot" type="unsigned long" dir="in"/>
    … …  
    38173832        nextKey (if there is any). @a nextValue is an optional parameter and
    38183833        if supplied, the next key's value is returned in it.
     3834
     3835        <result name="VBOX_E_OBJECT_NOT_FOUND">
     3836          Extra data @a key not found.
     3837        </result>
     3838
    38193839      </desc>
    38203840      <param name="key" type="wstring" dir="in">
    … …  
    38353855        If the requested data @a key does not exist, this function will
    38363856        succeed and return @c NULL in the @a value argument.
     3857
     3858        <result name="VBOX_E_FILE_ERROR">
     3859          Settings file not accessible.
     3860        </result>
     3861        <result name="VBOX_E_XML_ERROR">
     3862          Could not parse the settings file.
     3863        </result>
     3864
    38373865      </desc>
    38383866      <param name="key" type="wstring" dir="in">
    … …  
    38693897          when several clients change the same key at the same time.
    38703898        </note>
     3899
     3900        <result name="VBOX_E_FILE_ERROR">
     3901          Settings file not accessible.
     3902        </result>
     3903        <result name="VBOX_E_XML_ERROR">
     3904          Could not parse the settings file.
     3905        </result>
     3906
    38713907      </desc>
    38723908      <param name="key" type="wstring" dir="in">
    … …  
    38983934          <link to="IVirtualBox::unregisterMachine"/>.
    38993935        </note>
     3936
     3937        <result name="VBOX_E_FILE_ERROR">
     3938          Settings file not accessible.
     3939        </result>
     3940        <result name="VBOX_E_XML_ERROR">
     3941          Could not parse the settings file.
     3942        </result>
     3943        <result name="E_ACCESSDENIED">
     3944          Modification request refused.
     3945        </result>
     3946
    39003947      </desc>
    39013948    </method>
    … …  
    39413988
    39423989        <see>settingsFileVersion</see>
     3990
     3991        <result name="VBOX_E_FILE_ERROR">
     3992          Settings file not accessible.
     3993        </result>
     3994        <result name="VBOX_E_XML_ERROR">
     3995          Could not parse the settings file.
     3996        </result>
     3997        <result name="VBOX_E_INVALID_VM_STATE">
     3998          Virtual machine is not mutable.
     3999        </result>
     4000        <result name="E_ACCESSDENIED">
     4001          Modification request refused.
     4002        </result>
     4003
    39434004      </desc>
    39444005      <param name="bakFileName" type="wstring" dir="return">
    … …  
    39604021          <link to="IVirtualBox::unregisterMachine"/>.
    39614022        </note>
     4023
     4024        <result name="VBOX_E_INVALID_VM_STATE">
     4025          Virtual machine is not mutable.
     4026        </result>
     4027
    39624028      </desc>
    39634029    </method>
    … …  
    39844050          by calling <link to="#saveSettings()"/>.
    39854051        </note>
     4052
     4053        <result name="VBOX_E_INVALID_VM_STATE">
     4054          Cannot delete settings of a registered machine or
     4055          machine not mutable.
     4056        </result>
     4057        <result name="VBOX_E_IPRT_ERROR">
     4058          Could not delete the settings file.
     4059        </result>
     4060
    39864061      </desc>
    39874062    </method>
    … …  
    39934068        taken on this machine. This is useful if you want to traverse
    39944069        the whole tree of snapshots starting from the root.
     4070
     4071        <result name="VBOX_E_OBJECT_NOT_FOUND">
     4072          Virtual machine has no snapshots or snapshot not found.
     4073        </result>
     4074
    39954075      </desc>
    39964076      <param name="id" type="uuid" dir="in">
    … …  
    40054085      <desc>
    40064086        Returns a snapshot of this machine with the given name.
     4087
     4088        <result name="VBOX_E_OBJECT_NOT_FOUND">
     4089          Virtual machine has no snapshots or snapshot not found.
     4090        </result>
     4091
    40074092      </desc>
    40084093      <param name="name" type="wstring" dir="in">
    … …  
    40334118        folders and starts sharing it. Refer to the description of
    40344119        <link to="ISharedFolder"/> to read more about logical names.
     4120
     4121        <result name="VBOX_E_OBJECT_IN_USE">
     4122          Shared folder already exists.
     4123        </result>
     4124        <result name="VBOX_E_FILE_ERROR">
     4125          Shared folder @a hostPath not accessible.
     4126        </result>
     4127
    40354128      </desc>
    40364129      <param name="name" type="wstring" dir="in">
    … …  
    40504143        created by <link to="#createSharedFolder"/> from the collection of
    40514144        shared folders and stops sharing it.
     4145
     4146        <result name="VBOX_E_INVALID_VM_STATE">
     4147          Virtual machine is not mutable.
     4148        </result>
     4149        <result name="VBOX_E_OBJECT_NOT_FOUND">
     4150          Shared folder @a name does not exist.
     4151        </result>
     4152
    40524153      </desc>
    40534154      <param name="name" type="wstring" dir="in">
    … …  
    40654166          currently open.
    40664167        </note>
     4168
     4169        <result name="VBOX_E_INVALID_VM_STATE">
     4170          Machine session is not open.
     4171        </result>
     4172
    40674173      </desc>
    40684174      <param name="canShow" type="boolean" dir="return">
    … …  
    40914197          currently open.
    40924198        </note>
     4199
     4200        <result name="VBOX_E_INVALID_VM_STATE">
     4201          Machine session is not open.
     4202        </result>
     4203
    40934204      </desc>
    40944205      <param name="winId" type="unsigned long long" dir="return">
    … …  
    41054216      <desc>
    41064217        Reads an entry from the machine's guest property store.
     4218
     4219        <result name="VBOX_E_INVALID_VM_STATE">
     4220          Machine session is not open.
     4221        </result>
     4222
    41074223      </desc>
    41084224      <param name="name" type="wstring" dir="in">
    … …  
    41344250      <desc>
    41354251        Reads a value from the machine's guest property store.
     4252
     4253        <result name="VBOX_E_INVALID_VM_STATE">
     4254          Machine session is not open.
     4255        </result>
     4256
    41364257      </desc>
    41374258      <param name="property" type="wstring" dir="in">
    … …  
    41514272      <desc>
    41524273        Reads a property timestamp from the machine's guest property store.
     4274
     4275        <result name="VBOX_E_INVALID_VM_STATE">
     4276          Machine session is not open.
     4277        </result>
     4278
    41534279      </desc>
    41544280      <param name="property" type="wstring" dir="in">
    … …  
    41694295        Sets, changes or deletes an entry in the machine's guest property
    41704296        store.
     4297
     4298        <result name="E_ACCESSDENIED">
     4299          Property cannot be changed.
     4300        </result>
     4301        <result name="E_INVALIDARG">
     4302          Invalid @a flags.
     4303        </result>
     4304        <result name="VBOX_E_INVALID_VM_STATE">
     4305          Virtual machine is not mutable or session not open.
     4306        </result>
     4307        <result name="VBOX_E_INVALID_OBJECT_STATE">
     4308          Cannot set transient property when machine not running.
     4309        </result>
     4310
    41714311      </desc>
    41724312      <param name="property" type="wstring" dir="in">
    … …  
    41964336        store.  The flags field will be left unchanged or created empty for a
    41974337        new property.
    4198       </desc>
     4338
     4339        <result name="E_ACCESSDENIED">
     4340          Property cannot be changed.
     4341        </result>
     4342        <result name="VBOX_E_INVALID_VM_STATE">
     4343          Virtual machine is not mutable or session not open.
     4344        </result>
     4345        <result name="VBOX_E_INVALID_OBJECT_STATE">
     4346          Cannot set transient property when machine not running.
     4347        </result>
     4348      </desc>
     4349
    41994350      <param name="property" type="wstring" dir="in">
    42004351        <desc>
Note: See TracChangeset for help on using the changeset viewer.

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