Parallels C API Reference Guide
|
The PHT_VM_CONFIGURATION handle is used to manage the virtual machine configuration. The handle is obtained by calling the PrlVm_GetConfig function.
|
Name |
Description |
|
The PrlVmCfg_AddDefaultDevice function automates the task of setting devices in a virtual machine. | |
|
Creates a new handle of type PHT_BOOT_DEVICE and adds it to the specified virtual machine boot device list. | |
|
Creates a new handle of type PHT_SCREEN_RESOLUTION and adds it to the specified virtual machine resolution list. | |
|
Creates a new handle of type PHT_SHARE and adds it to the specified virtual machine list of shares. | |
|
Creates a new virtual device handle of the specified type. | |
|
Obtains a handle of type PHT_ACCESS_RIGHTS. | |
|
Obtains a handles list of all virtual devices in a virtual machine. | |
|
Determines the current dock mode for the specified virtual machine. | |
|
Determines if the specified virtual machine is set to start automatically on Parallels Service startup. | |
|
Returns the time delay used during the virtual machine automatic startup. | |
|
Determines the mode of the automatic shutdown for the specified virtual machine. | |
|
Determines the specified virtual machine background process priority type. | |
|
Obtains a handle of type PHT_BOOT_DEVICE containing information about a specified device from the virtual machine boot device priority list. | |
|
Determines the number of devices in the virtual machine boot device priority list. | |
|
The PrlVmCfg_GetConfigValidity function returns an error code. | |
|
Determines the virtual machine CPU acceleration level. | |
|
Determines the number of CPUs in the virtual machine. | |
|
Determines the specified virtual machine CPU limit. | |
|
Determines the specified virtual machine CPU mode (32 bit or 64 bit). | |
|
Determines the number of CPU units allocated to a virtual machine. | |
|
Returns the virtual machine custom property information. | |
|
Returns the default gateway of the specified virtual machine. | |
|
The PrlVmCfg_GetDefaultHddSize function returns the default hard disk size for to the specified OS type and version. | |
|
The PrlVmCfg_GetDefaultMemSize function returns the default RAM size for to the specified OS type and version. | |
|
The PrlVmCfg_GetDefaultVideoRamSize function returns the default video RAM size for to the specified OS type and version. | |
|
Returns the specified virtual machine description. | |
|
Obtains a handle to a virtual device in a virtual machine according to the specified device type and index. | |
|
Determines the total number of devices of any type installed in the virtual machine. | |
|
Obtains the number of virtual devices of the specified type available in the specified virtual machine. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_DISPLAY containing information about a display device in a virtual machine. | |
|
Determines the number of display devices in a virtual machine. | |
|
Returns the virtual machine dock icon type. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_FLOPPY containing information about the specified floppy disk drive in a virtual machine. | |
|
Determines the number of floppy disk drives in a virtual machine. | |
|
Returns foreground processes priority for the specified virtual machine. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_GENERIC_PCI containing information about a generic PCI device in a virtual machine. | |
|
Determines the number of generic PCI devices in a virtual machine. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_GENERIC_SCSI containing information about a generic SCSI device in a virtual machine. | |
|
Determines the number of generic SCSI devices in a virtual machine. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_HARD_DISK containing the specified virtual hard disk information. | |
|
Determines the number of virtual hard disks in a virtual machine. | |
|
Returns the virtual machine home directory name and path. | |
|
Obtains the hostname of the specified virtual machine. | |
|
Returns the name of the icon file used by the specified virtual machine. | |
|
Determines the specified virtual machine I/O priority. | |
|
Returns the date and time when the specified virtual machine was last modified. | |
|
Returns the name of the user who last modified the specified virtual machine. | |
|
Returns the name of the specified virtual machine. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_NET_ADAPTER containing information about a virtual network adapter in a virtual machine. | |
|
Determines the number of network adapters in a virtual machine. | |
|
Obtains the list of services available in the virtual machine offline management. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_OPTICAL_DISK containing information a virtual optical disk in a virtual machine. | |
|
Determines the number of optical disks in the specified virtual machine. | |
|
Returns the type of the operating system that the specified virtual machine is running. | |
|
Returns the version of the operating system that the specified virtual machine is running. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_PARALLEL_PORT containing information about a virtual parallel port in the specified virtual machine. | |
|
Determines the number of virtual parallel ports in the specified virtual machine. | |
|
Returns the virtual machine memory (RAM) size, in megabytes. | |
|
Returns the specified virtual machine screen resolution. | |
|
Returns the virtual machine screen resolutions count. | |
|
Obtains the list of globally defined search domains that will be assigned to a virtual machine on the guest operating system side. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_SERIAL_PORT containing information about a serial port in a virtual machine. | |
|
Determines the number of serial ports in a virtual machine. | |
|
Returns the hostname of the machine hosting the specified virtual machine. | |
|
Returns the UUID of the machine hosting the specified virtual machine. | |
|
Obtains a handle of type PHT_SHARE containing information about a shared folder. | |
|
Determines the number of shared folders in a virtual machine. | |
|
Returns smart guard snapshot creation interval in seconds. | |
|
Returns smart guard snapshot maximum storing snapshots count. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_SOUND containing information about a sound device in a virtual machine. | |
|
Determines the number of sound devices in a virtual machine. | |
|
Returns the automatic startup login mode for the specified virtual machine. | |
|
Returns the user name used during the specified virtual machine automatic startup. | |
|
Returns the virtual machine system flags. | |
|
Returns time synchronization between guest and host interval in seconds. | |
|
Determines the current undo disks mode for the specified virtual machine. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_USB_DEVICE containing information about a USB device in a virtual machine. | |
|
Determines the number of USB devices in a virtual machine. | |
|
Returns the UUID (universally unique ID) of the specified virtual machine. | |
|
Returns the video memory size of the specified virtual machine. | |
|
Returns the VNC hostname of the specified virtual machine. | |
|
Returns the VNC mode of the specified virtual machine. | |
|
Returns the VNC password for the specified virtual machine. | |
|
Returns the VNC port number for the specified virtual machine. | |
|
Returns the current window mode the specified virtual machine is in. | |
|
Determines whether select boot device should be shown on virtual machine startup. | |
|
Returns sign whether auto capture and release mouse mode is enabled. | |
|
Returns Virtual Machine close app on shutdown sign. | |
|
Returns Virtual Machine CPU VTx support enabling sign. | |
|
Determines if a virtual machine requires a default device of the specified type if it's going to run an operating system of the specified type. | |
|
Gets the APIC using for virtual machine in runtime. | |
|
Determines if disk cache write-back is enabled for the specified virtual machine. | |
|
Determines the guest OS window behavior in coherence mode. | |
|
Determines if host shared folders are mounted automatically in a given virtual machine. | |
|
Determines if guest sharing is enabled (the guest OS disk drives are visible in the host OS). | |
|
Determines if VM virtual disks will be added to Spotlight search subsystem. | |
|
Determines if host sharing is enabled (host shared folders are visible in the guest OS). | |
|
Determines whether host disks shared into guest Windows OS will be maped on drive letters. | |
|
Determines if the specified virtual machine uses a multi-display mode. | |
|
Determines whether the offline management feature is enabled for a virtual machine. | |
|
Determines if a virtual machine OS resolution is in full screen mode. | |
|
Determines if Windows task bar relocation feature is enabled in a virtual machine when it runs in the coherence mode. | |
|
Determines if additional screen resolution support is enabled in a virtual machine. | |
|
Determines whether all host disks will be present at guest OS as shares. | |
|
Returns sign whether clipboard should sharing between guest and host. | |
|
Returns sign whether shared profile is enabled. | |
|
Determines whether host user home dir will be present at guest OS as share. | |
|
Determines if Windows task bar is displayed when the virtual machine runs in coherence mode. | |
|
Returns sign whether smart guard is enabled. | |
|
Returns sign whether smart guard should notify user before snapshot creation. | |
|
Determines if the specified virtual machine object contains a virtual machine or a template configuration information. | |
|
Returns sign whether time synchronization between guest and host is enabled. | |
|
Returns sign whether time synchronization smart mode between guest and host is enabled. | |
|
Determines whether the Parallels Tools AutoUpdate feature is enabled for a virtual machine. | |
|
Determines whether the use default answers mechanism active for the virtual machine. | |
|
Returns sign whether use desktop in shared profile is enabled. | |
|
Returns sign whether use documents in shared profile is enabled. | |
|
Returns sign whether use music in shared profile is enabled. | |
|
Returns sign whether use pictures in shared profile is enabled. | |
|
Returns sign whether user defined shared folders enabled. | |
|
Switches on/off select boot device dialog on virtual machine startup. | |
|
Sets the dock mode for the applications (see PRL_APP_IN_DOCK_MODE for available options). | |
|
Lets to set auto capture and release mouse mode enabling sign. | |
|
Allows to sets the automatic startup option for the specified virtual machine. | |
|
Sets the time delay that will be used during the virtual machine automatic startup. | |
|
Allows to set the automatic shutdown mode for the specified virtual machine. | |
|
Sets virtual machine background processes priority. | |
|
Sets Virtual Machine close app on shutdown sign. | |
|
Sets CPU acceleration level for the specified virtual machine. | |
|
Sets the number of CPUs for the specified virtual machine (the CPUs should be present in the machine). | |
|
Sets limit of CPU usage for the virtual machine in percents. | |
|
Sets CPU mode (32 bit or 64 bit) for the specified virtual machine. | |
|
Sets the number of CPU units that will be allocated to a virtual machine. | |
|
Sets the virtual machine custom property information. | |
|
The PrlVmCfg_SetDefaultConfig function selects a default configuration for a new virtual machine based on the operating system that the virtual machine will be running. | |
|
Sets the specified virtual machine default gateway. | |
|
Sets the virtual machine description. | |
|
Sets the APIC using for virtual machine in runtime. | |
|
Sets the virtual machine disk cache write-back option. | |
|
Sets the virtual machine dock icon type. | |
|
Sets the exclude dock option. | |
|
Sets the virtual machine foreground processes priority. | |
|
Sets the guest OS sharing auto-mount option. | |
|
Enables the guest sharing feature. | |
|
Sets the VM virtual disks added to Spotlight search subsystem sign. | |
|
Sets the specified virtual machine hostname. | |
|
Enables host sharing for the specified virtual machine. | |
|
Sets the virtual machine icon. | |
|
Sets the specified virtual machine I/O priority. | |
|
Enables mapping of shared host disks on drive letters for the specified virtual machine. | |
|
Sets the virtual machine multi-display option. | |
|
Sets the specified virtual machine name. | |
|
Enables or disables the offline management feature for a virtual machine. | |
|
Allows to manually set offline services that will be available in the virtual machine offline management. | |
|
Sets the virtual machine OS resolution in full screen mode option. | |
|
Sets the virtual machine guest OS version. | |
|
Sets the virtual machine memory (RAM) size. | |
|
Allows to enable or disable the Windows task bar relocation feature. | |
|
Sets the additional screen resolution support option in the specified virtual machine | |
|
Allows to manually set the global search domain list that will be assigned to the virtual machine on the guest OS side. | |
|
Enables sharing of all host disks for the specified virtual machine. | |
|
Lets to set clipboard sharing between guest and host enabling sign. | |
|
Lets to set shared profile enabling sign. | |
|
Enables sharing of host user home dir for the specified virtual machine. | |
|
Allows to show or hide the Windows task bar when the virtual machine is running in coherence mode. | |
|
Lets to set smart guard enabling sign. | |
|
Lets to set smart guard snapshot creation interval in seconds. | |
|
Lets to set smart guard imaximum storing snapshots count. | |
|
Lets to set smart guard noification enabling sign. | |
|
Allows to set the automatic startup login mode for the specified virtual machine. | |
|
Allows to set the automatic startup user login and password for the specified virtual machine. | |
|
Sets Virtual Machine system flags. | |
|
Allows to modify a regular virtual machine to become a template, and vise versa. | |
|
Lets to set time synchronization between guest and host enabling sign. | |
|
Lets to set time synchronization between guest and host interval in seconds. | |
|
Lets to set time synchronization smart mode between guest and host enabling sign. | |
|
Enables or disables the Parallels Tools AutoUpdate feature for a virtual machine. | |
|
Sets the undo disks mode for the virtual machine (see PRL_UNDO_DISKS_MODE for available options). | |
|
Enables the use default answers mechanism in a virtual machine. | |
|
Lets to set use desktop in shared profile enabling sign. | |
|
Lets to set use documents in shared profile enabling sign. | |
|
Lets to set use music in shared profile enabling sign. | |
|
Lets to set use pictures in shared profile enabling sign. | |
|
Lets to set user defined shared folders enabling sign. | |
|
Sets the virtual machine UUID (universally unique ID). | |
|
Sets the virtual machine video memory size. | |
|
Sets the virtual machine VNC host name. | |
|
Sets the virtual machine VNC mode. | |
|
Sets the virtual machine VNC password. | |
|
Sets the virtual machine VNC port number. | |
|
Sets the virtual machine window mode. |
Copyright (c) 1999-2009 Parallels Software International Inc.
|
What do you think about this topic? Send feedback!
|