IDVDDrive Interface Reference

The IDVDDrive interface represents the virtual CD/DVD drive of the virtual machine. More...

List of all members.

Public Member Functions

void mountImage (in uuid imageId)
 Mounts the specified image.
void captureHostDrive (in IHostDVDDrive drive)
 Captures the specified host drive.
void unmount ()
 Unmounts the currently mounted image/device.
void getImage ([retval] out IDVDImage image)
 Gets the currently mounted image ID.
void getHostDrive ([retval] out IHostDVDDrive drive)
 Gets the currently mounted image ID.

Public Attributes

readonly attribute DriveState state
 Current drive state.
attribute boolean passthrough
 When a host drive is mounted and passthrough is enabled the guest will be able to directly send SCSI commands to the host drive.


Detailed Description

The IDVDDrive interface represents the virtual CD/DVD drive of the virtual machine.

Used in IMachine::DVDDrive.

Interface ID:
{D9BD101A-8079-4FB9-BAD1-31BF32482B75}

Member Function Documentation

void IDVDDrive::mountImage ( in uuid  imageId  ) 

Mounts the specified image.

void IDVDDrive::captureHostDrive ( in IHostDVDDrive  drive  ) 

Captures the specified host drive.

void IDVDDrive::unmount (  ) 

Unmounts the currently mounted image/device.

void IDVDDrive::getImage ( [retval] out IDVDImage  image  ) 

Gets the currently mounted image ID.

void IDVDDrive::getHostDrive ( [retval] out IHostDVDDrive  drive  ) 

Gets the currently mounted image ID.


Member Data Documentation

readonly attribute DriveState IDVDDrive::state

Current drive state.

attribute boolean IDVDDrive::passthrough

When a host drive is mounted and passthrough is enabled the guest will be able to directly send SCSI commands to the host drive.

This enables the guest to use CD/DVD writers but is potentially dangerous.


Generated on Fri Nov 21 21:38:41 2008 for VirtualBox Main API by  doxygen 1.5.5