Changeset 18686 in vbox for trunk/src/VBox/Main/idl/VirtualBox.xidl
- Timestamp:
- Apr 3, 2009 1:06:39 PM (16 years ago)
- File:
-
- 1 edited
-
trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (20 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/VBox/Main/idl/VirtualBox.xidl
r18684 r18686 452 452 453 453 <pre> 454 +---------------------------------- -(same sate as before the call)------+454 +----------------------------------(same state as before the call)------+ 455 455 | | 456 456 +-> PoweredOff --+ | … … 466 466 467 467 <pre> 468 +---------------------------------- -(same sate as before the call)------+468 +----------------------------------(same state as before the call)------+ 469 469 | | 470 470 +-> PoweredOff --+ | … … 501 501 502 502 <const name="Null" value="0"> 503 <desc>Null value (n ver used by the API).</desc>503 <desc>Null value (never used by the API).</desc> 504 504 </const> 505 505 <const name="PoweredOff" value="1"> … … 1653 1653 until <link to="IMachine::saveSettings"/> is called. If the 1654 1654 specified settings file already exists, this method 1655 will fail with <link to="VBOX_E_FILE_ERROR"/>. .1655 will fail with <link to="VBOX_E_FILE_ERROR"/>. 1656 1656 1657 1657 See <link to="#createMachine"/> for more information. … … 2757 2757 <desc> 2758 2758 Creates a backup copy of the global settings file 2759 (<link to=" #settingsFilePath"/>) in case of auto-conversion, and then2760 calls <link to="#saveSettings"/>.2759 (<link to="IVirtualBox::settingsFilePath"/>) in case of auto-conversion, 2760 and then calls <link to="IVirtualBox::saveSettings"/>. 2761 2761 2762 2762 Note that the backup copy is created <b>only</b> if the settings file 2763 2763 auto-conversion took place (see <link to="#settingsFileVersion"/> for 2764 2764 details). Otherwise, this call is fully equivalent to 2765 <link to=" #saveSettings"/> and no backup copying is done.2765 <link to="IVirtualBox::saveSettings"/> and no backup copying is done. 2766 2766 2767 2767 The backup copy is created in the same directory where the original … … 3296 3296 uuid="56d9403f-3425-4118-9919-36f2a9b8c77c" 3297 3297 > 3298 <desc>Used with <link to=" getValuesByType" /> to describe the value3298 <desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value 3299 3299 type to fetch.</desc> 3300 3300 … … 3443 3443 3444 3444 <method name="getDescriptionByType"> 3445 <desc>This is the same as <link to=" getDescription" /> except that you can specify which types3445 <desc>This is the same as <link to="#getDescription" /> except that you can specify which types 3446 3446 should be returned.</desc> 3447 3447 … … 3473 3473 3474 3474 <method name="getValuesByType"> 3475 <desc>This is the same as <link to=" getDescriptionByType" /> except that you can specify which3475 <desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which 3476 3476 value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible 3477 3477 values.</desc> … … 3494 3494 <desc> 3495 3495 This method allows the appliance's user to change the configuration for the virtual 3496 system descriptions. For each array item returned from <link to=" getDescription" />,3496 system descriptions. For each array item returned from <link to="#getDescription" />, 3497 3497 you must pass in one boolean value and one configuration value. 3498 3498 … … 4320 4320 <desc> 4321 4321 Current version of the format of the settings file of this machine 4322 (<link to=" #settingsFilePath"/>).4322 (<link to="IMachine::settingsFilePath"/>). 4323 4323 4324 4324 The version string has the following format: … … 4768 4768 <link to="IStorageController" />. 4769 4769 4770 @a name identifies the controller withsubsequent calls such as4770 @a name identifies the controller for subsequent calls such as 4771 4771 <link to="#getStorageControllerByName" /> or 4772 4772 <link to="#removeStorageController" /> or … … 4974 4974 <desc> 4975 4975 Creates a backup copy of the machine settings file (<link 4976 to=" #settingsFilePath"/>) in case of auto-conversion, and then calls4977 <link to=" #saveSettings"/>.4976 to="IMachine::settingsFilePath"/>) in case of auto-conversion, and then calls 4977 <link to="IMachine::saveSettings"/>. 4978 4978 4979 4979 Note that the backup copy is created <b>only</b> if the settings file 4980 4980 auto-conversion took place (see <link to="#settingsFileVersion"/> for 4981 4981 details). Otherwise, this call is fully equivalent to 4982 <link to=" #saveSettings"/> and no backup copying is done.4982 <link to="IMachine::saveSettings"/> and no backup copying is done. 4983 4983 4984 4984 The backup copy is created in the same directory where the original … … 5607 5607 <desc> 5608 5608 Notification when a property of one of the 5609 virtual <link to="IMachine:: getStorageControllers">storage controllers</link>5610 changes. Interested callees should usequery the corresponding collections5609 virtual <link to="IMachine::storageControllers">storage controllers</link> 5610 changes. Interested callees should query the corresponding collections 5611 5611 to find out what has changed. 5612 5612 </desc> … … 6606 6606 <method name="discardCurrentState"> 6607 6607 <desc> 6608 This operation is similar to <link to=" #discardSnapshot"/> but6608 This operation is similar to <link to="IConsole::discardSnapshot"/> but 6609 6609 affects the current machine state. This means that the state stored in 6610 6610 the current snapshot will become a new current state, and all current … … 6646 6646 doing <link to="IConsole::discardSnapshot">discardSnapshot</link> 6647 6647 (currentSnapshot.id(), progress) followed by 6648 <link to=" #discardCurrentState"/>.6648 <link to="IConsole::discardCurrentState"/>. 6649 6649 6650 6650 As a result, the machine will be fully restored from the … … 6657 6657 machine will be restored from its last snapshot, before discarding 6658 6658 it. This differs from performing a single 6659 <link to=" #discardSnapshot"/> call (note that no6660 <link to=" #discardCurrentState"/> will be possible after it)6659 <link to="IConsole::discardSnapshot"/> call (note that no 6660 <link to="IConsole::discardCurrentState"/> will be possible after it) 6661 6661 to the effect that the latter will preserve the current state instead of 6662 6662 discarding it. … … 11147 11147 <attribute name="path" type="wstring"> 11148 11148 <desc> 11149 Path to the serial port's pipe on the host when <link to=" #hostMode"/> is11149 Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is 11150 11150 PortMode_HostPipe, or the host serial device name when 11151 <link to="#hostMode"/> is PortMode_HostDevice. In either of the above 11152 cases, setting a @c null or an empty string as the attribute's value 11153 will result into an error. Otherwise, the value of this property is 11154 ignored. 11151 <link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both 11152 cases, setting a @c null or empty string as the attribute's value 11153 is an error. Otherwise, the value of this property is ignored. 11155 11154 </desc> 11156 11155 </attribute> … … 12731 12730 <attribute name="minPortCount" type="unsigned long" readonly="yes"> 12732 12731 <desc> 12733 Minimum number of ports which can be set with 12734 <link to="IStorageController::SetPortCount"/>. 12732 Minimum number of ports that <link to="IStorageController::portCount"/> can be set to. 12735 12733 </desc> 12736 12734 </attribute> … … 12738 12736 <attribute name="maxPortCount" type="unsigned long" readonly="yes"> 12739 12737 <desc> 12740 Maximum number of ports which can be set with 12741 <link to="IStorageController::SetPortCount"/>. 12738 Maximum number of ports that <link to="IStorageController::portCount"/> can be set to. 12742 12739 </desc> 12743 12740 </attribute> … … 12752 12749 <desc> 12753 12750 The number of currently usable ports on the controller. 12754 The minimum and maximum number of ports for one controller type can12755 be determined with <link to="IStorageController::GetMinPortCount"/>12756 and <link to="IStorageController:: GetMaxPortCount"/>..12751 The minimum and maximum number of ports for one controller are 12752 stored in <link to="IStorageController::minPortCount"/> 12753 and <link to="IStorageController::maxPortCount"/>. 12757 12754 </desc> 12758 12755 </attribute>
Note:
See TracChangeset
for help on using the changeset viewer.
