Virtual Device Functions

This section describes common virtual device management functions.

Description

Common virtual device management functions can operate on virtual devices of the following types:

PHT_VIRTUAL_DEV_FLOPPY

PHT_VIRTUAL_DEV_HARD_DISK

PHT_VIRTUAL_DEV_NET_ADAPTER

PHT_VIRTUAL_DEV_OPTICAL_DISK

PHT_VIRTUAL_DEV_PARALLEL_PORT

PHT_VIRTUAL_DEV_SERIAL_PORT

PHT_VIRTUAL_DEV_SOUND

PHT_VIRTUAL_DEV_USB_DEVICE

Each common function accepts a handle of type PRL_HANDLE identifying the virtual device to operate on. The actual handle passed can be of any type from the list above. In addition to common function described here, most of the individual virtual devices have functions specific to their respective types. For device-type specific functions, follow links to virtual device handles in the list above.

Functions

	Name	Description
	PrlVmDev_Connect	The PrlVmDev_Connect function allows to connect virtual devices while the virtual machine is running.
	PrlVmDev_CopyImage	Copies a virtual device image to another custom location.
	PrlVmDev_Create	Creates a new virtual device handle not bound to any virtual machine.
	PrlVmDev_CreateImage	Physically creates a virtual device image on the host.
	PrlVmDev_Disconnect	Allows to disconnect a device while the virtual machine is running.
	PrlVmDev_GetDescription	Returns the description of a specified virtual device.
	PrlVmDev_GetEmulatedType	Returns the virtual device emulation type.
	PrlVmDev_GetFriendlyName	Returns the virtual device user friendly name.
	PrlVmDev_GetIfaceType	Returns the virtual device interface type (IDE or SCSI).
	PrlVmDev_GetImagePath	Returns virtual device image path.
	PrlVmDev_GetIndex	Returns an index identifying the virtual device.
	PrlVmDev_GetOutputFile	Returns the virtual device output file.
	PrlVmDev_GetStackIndex	Returns the virtual device stack index (position at the controller (IDE or SCSI) bus).
	PrlVmDev_GetSubType	Returns the virtual device subtype.
	PrlVmDev_GetSysName	Returns the virtual device system name.
	PrlVmDev_GetType	Returns the type of the specified device.
	PrlVmDev_IsConnected	Checks if the specified virtual device is connected.
	PrlVmDev_IsEnabled	Determines if the specified device is enabled.
	PrlVmDev_IsPassthrough	Determines if the passthrough mode is enabled for the specified mass storage device.
	PrlVmDev_IsRemote	Determines if the specified virtual device is a remote device.
	PrlVmDev_Remove	Removes the specified virtual device handle from the parent virtual machine list.
	PrlVmDev_ResizeImage	Resize a virtual device image.
	PrlVmDev_SetConnected	Connects the specified virtual device.
	PrlVmDev_SetDefaultStackIndex	Automatically generates and assigns a stack index to a virtual device (a corresponding device interface, IDE or SCSI, has to be set in advance).
	PrlVmDev_SetDescription	Sets the description for a specified virtual device.
	PrlVmDev_SetEmulatedType	Sets the specified virtual device emulation type.
	PrlVmDev_SetEnabled	Enables the specified virtual device..
	PrlVmDev_SetFriendlyName	Sets virtual device user-friendly name.
	PrlVmDev_SetIfaceType	Sets the virtual device interface type (IDE or SCSI).
	PrlVmDev_SetImagePath	Sets the virtual device image path.
	PrlVmDev_SetIndex	Sets an index identifying the virtual device.
	PrlVmDev_SetOutputFile	Sets the virtual device output file.
	PrlVmDev_SetPassthrough	Enables the passthrough mode for the specified mass storage device (optical ot hard disk).
	PrlVmDev_SetRemote	Changes the "remote" flag for the specified device.
	PrlVmDev_SetStackIndex	Sets the virtual device stack index (position at the IDE or SCSI controller bus).
	PrlVmDev_SetSubType	Sets the virtual device subtype.
	PrlVmDev_SetSysName	Sets virtual device system name.

Links

Functions, Common Functions, Legend