Changeset 97709 in vbox for trunk/src/VBox/Main/idl
- Timestamp:
- Nov 29, 2022 7:41:42 PM (2 years ago)
- svn:sync-xref-src-repo-rev:
- 154766
- File:
-
- 1 edited
-
trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (5 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/VBox/Main/idl/VirtualBox.xidl
r97523 r97709 324 324 The standard COM result codes that may originate from our methods include: 325 325 326 <table> 327 <tr><td>E_INVALIDARG</td> 328 <td> 329 Returned when the value of the method's argument is not within the range 330 of valid values. This should not be confused with situations when the 331 value is within the range but simply doesn't suit the current object 332 state and there is a possibility that it will be accepted later (in such 333 cases VirtualBox-specific codes are returned, for example, 334 <link to="VBOX_E_OBJECT_NOT_FOUND"/>). 335 </td> 336 </tr> 337 <tr><td>E_POINTER</td> 338 <td> 339 Returned if a memory pointer for the output argument is invalid (for 340 example, @c null). When pointers representing input arguments (such 341 as strings) are invalid, E_INVALIDARG is returned. 342 </td> 343 </tr> 344 <tr><td>E_ACCESSDENIED</td> 345 <td> 346 Returned when the called object is not ready. Since the lifetime of a 347 public COM object cannot be fully controlled by the implementation, 348 VirtualBox maintains the readiness state for all objects it creates and 349 returns this code in response to any method call on the object that was 350 deactivated by VirtualBox and is not functioning any more. 351 </td> 352 </tr> 353 <tr><td>E_OUTOFMEMORY</td> 354 <td> 355 Returned when a memory allocation operation fails. 356 </td> 357 </tr> 358 </table> 326 <dl> 327 <dt><tt>E_INVALIDARG</tt></dt> 328 <dd> 329 Returned when the value of the method's argument is not within the range 330 of valid values. This should not be confused with situations when the 331 value is within the range but simply doesn't suit the current object 332 state and there is a possibility that it will be accepted later (in such 333 cases VirtualBox-specific codes are returned, for example, 334 <link to="VBOX_E_OBJECT_NOT_FOUND"/>). 335 </dd> 336 <dt><tt>E_POINTER</tt></dt> 337 <dd> 338 Returned if a memory pointer for the output argument is invalid (for 339 example, @c null). When pointers representing input arguments (such 340 as strings) are invalid, E_INVALIDARG is returned. 341 </dd> 342 <dt><tt>E_ACCESSDENIED</tt></dt> 343 <dd> 344 Returned when the called object is not ready. Since the lifetime of a 345 public COM object cannot be fully controlled by the implementation, 346 VirtualBox maintains the readiness state for all objects it creates and 347 returns this code in response to any method call on the object that was 348 deactivated by VirtualBox and is not functioning any more. 349 </dd> 350 <dt><tt>E_OUTOFMEMORY</tt></dt> 351 <dd> 352 Returned when a memory allocation operation fails. 353 </dd> 354 </dl> 359 355 </desc> 360 356 </descGroup> … … 14943 14939 The following flags are available: 14944 14940 14945 <table> 14946 <tr> 14947 <td>CopyIntoExisting</td> 14948 <td>Allow copying into an existing destination directory.</td> 14949 </tr> 14950 </table> 14951 14952 <table> 14953 <tr> 14954 <td>NoReplace</td> 14955 <td>Do not replace any existing destination files on 14956 the destination.</td> 14957 </tr> 14958 <tr> 14959 <td>FollowLinks</td> 14960 <td>Follows (and handles) (symbolic) links.</td> 14961 </tr> 14962 <tr> 14963 <td>Update</td> 14964 <td>Only copy when the source file is newer than the destination 14965 file or when the destination file is missing.</td> 14966 </tr> 14967 </table> 14968 14941 <dl> 14942 <dt><tt>CopyIntoExisting</tt></dt> 14943 <dd>Allow copying into an existing destination directory.</dd> 14944 <dt><tt>NoReplace</tt></dt> 14945 <dd>Do not replace any existing destination files on 14946 the destination.</dd> 14947 <dt><tt>FollowLinks</tt></dt> 14948 <dd>Follows (and handles) (symbolic) links.</dd> 14949 <dt><tt>Update</tt></dt> 14950 <dd>Only copy when the source file is newer than the destination 14951 file or when the destination file is missing.</dd> 14952 </dl> 14969 14953 </desc> 14970 14954 </param> … … 14998 14982 The following flags are available: 14999 14983 15000 <table> 15001 <tr> 15002 <td>CopyIntoExisting</td> 15003 <td>Allow copying into an existing destination directory.</td> 15004 </tr> 15005 </table> 15006 15007 <table> 15008 <tr> 15009 <td>NoReplace</td> 15010 <td>Do not replace any existing destination files on 15011 the destination.</td> 15012 </tr> 15013 <tr> 15014 <td>FollowLinks</td> 15015 <td>Follows (and handles) (symbolic) links.</td> 15016 </tr> 15017 <tr> 15018 <td>Update</td> 15019 <td>Only copy when the source file is newer than the destination 15020 file or when the destination file is missing.</td> 15021 </tr> 15022 </table> 14984 <dl> 14985 <dt><tt>CopyIntoExisting</tt></dt> 14986 <dd>Allow copying into an existing destination directory.</dd> 14987 <dt><tt>NoReplace</tt></dt> 14988 <dd>Do not replace any existing destination files on 14989 the destination.</dd> 14990 <dt><tt>FollowLinks</tt></dt> 14991 <dd>Follows (and handles) (symbolic) links.</dd> 14992 <dt><tt>Update</tt></dt> 14993 <dd>Only copy when the source file is newer than the destination 14994 file or when the destination file is missing.</dd> 14995 </dl> 15023 14996 15024 14997 </desc> … … 20357 20330 The current state of mouse buttons. Every bit represents 20358 20331 a mouse button as follows: 20359 < table>20360 < tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>20361 < tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>20362 < tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>20363 </ table>20364 A value of <tt>1</tt>means the corresponding button is pressed.20332 <dl> 20333 <dt>Bit 0 (<tt>0x01</tt>)</dt><dd>left mouse button</dd> 20334 <dt>Bit 1 (<tt>0x02</tt>)</dt><dd>right mouse button</dd> 20335 <dt>Bit 2 (<tt>0x04</tt>)</dt><dd>middle mouse button</dd> 20336 </dl> 20337 A value of @c 1 means the corresponding button is pressed. 20365 20338 otherwise it is released. 20366 20339 </desc> … … 20422 20395 The current state of mouse buttons. Every bit represents 20423 20396 a mouse button as follows: 20424 < table>20425 < tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>20426 < tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>20427 < tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>20428 </ table>20397 <dl> 20398 <dt>Bit 0 (<tt>0x01</tt>)</dt><dd>left mouse button</dd> 20399 <dt>Bit 1 (<tt>0x02</tt>)</dt><dd>right mouse button</dd> 20400 <dt>Bit 2 (<tt>0x04</tt>)</dt><dd>middle mouse button</dd> 20401 </dl> 20429 20402 A value of @c 1 means the corresponding button is pressed. 20430 20403 otherwise it is released.
Note:
See TracChangeset
for help on using the changeset viewer.
