Changeset 14699
- Timestamp:
- 11/27/08 13:08:21 (1 month ago)
- Files:
-
- trunk/src/VBox/Main/idl/VirtualBox.xidl (modified) (4 diffs)
Legend:
- Unmodified
- Added
- Removed
- Modified
- Copied
- Moved
trunk/src/VBox/Main/idl/VirtualBox.xidl
r14697 r14699 1318 1318 1319 1319 <li> 1320 Call <link to="IMachine::saveSettings " /> to write the settings1320 Call <link to="IMachine::saveSettings()" /> to write the settings 1321 1321 to the machine's XML settings file. The configuration of the newly 1322 created machine will not be saved to disk (and the settings subfolder 1323 and file, as described below, will not be created) until this method 1324 is called. 1322 created machine will not be saved to disk until this method is 1323 called. 1325 1324 </li> 1326 1325 1327 1326 <li> 1328 Call <link to="#registerMachine " /> to have the machine show up in1329 the list of machines registered withVirtualBox.1327 Call <link to="#registerMachine()" /> to add the machine to the list 1328 of machines known to VirtualBox. 1330 1329 </li> 1331 1330 </ol> … … 1340 1339 1341 1340 Every machine has a <i>settings file</i> that is used to store 1342 the machine configuration. This file is stored in the directory 1343 called <i>machine settings subfolder</i>. Unless specified otherwise, 1344 both the subfolder and the settings file will have a name that 1345 corresponds to the name of the virtual machine. You can specify 1346 where to create the machine settings subfolder using the @a 1347 baseFolder argument. The base folder can be absolute (full path) 1348 or relative to the <link to="IVirtualBox::homeFolder">VirtualBox home 1341 the machine configuration. This file is stored in a directory called the 1342 <i>machine settings subfolder</i>. Both the settings subfolder and file 1343 will have a name that corresponds to the name of the virtual machine. 1344 You can specify where to create the machine setting subfolder using the 1345 @a baseFolder argument. The base folder can be absolute (full path) or 1346 relative to the <link to="IVirtualBox::homeFolder">VirtualBox home 1349 1347 directory</link>. 1350 1348 1351 1349 If @a baseFolder is a null or empty string (which is recommended), the 1352 1350 <link to="ISystemProperties::defaultMachineFolder">default machine 1353 settings folder</link> will be used as a base folder to create the1354 machine settings subfolder and file, otherwise the given folder will be1355 used. The full path to the resulting settings file will have the1356 followingstructure:1351 settings folder</link> will be used as a base folder for the created 1352 machine. Otherwise the given base folder will be used. In either case, 1353 the full path to the resulting settings file has the following 1354 structure: 1357 1355 <pre> 1358 1356 <base_folder>/<machine_name>/<machine_name>.xml … … 1360 1358 1361 1359 Note that if the resulting settings file already exists, this method 1362 will fail .1360 will fail with <link to="VBOX_E_FILE_ERROR"/>. 1363 1361 1364 1362 Optionally, you may specify an UUID of to assign to the created machine. 1365 1363 However, this is not recommended and you should normally pass an empty 1366 1364 (null) UUID to this method so that a new UUID will be automatically 1367 generated .1365 generated for every created machine. 1368 1366 1369 1367 <note> … … 1419 1417 saved to disk (and therefore no settings file is created) 1420 1418 until <link to="IMachine::saveSettings()"/> is called. If the 1421 specified settings file already exists, 1422 <link to="IMachine::saveSettings()"/> will return an error.1419 specified settings file already exists, this method 1420 will fail with <link to="VBOX_E_FILE_ERROR"/>.. 1423 1421 1424 1422 See <link to="#createMachine()"/> for more information.
