PHT_VIRTUAL

The PHT_VIRTUAL_DISK handle is used to create, configure, and manage Parallels virtual disks. A virtual disk is comprised of a set of files including a configuration file containing information about the disk parameters (number of heads, cylinders, sectors, etc.) and the files that are used for data storage. Once created, a virtual disk can be connected to a virtual machine and recognized by it, just like a physical hard disk can be installed in a physical box. To create a new virtual disk use PrlDisk_CreateDisk or PrlDisk_CreateDisk_Local. To obtain a handle to an existing virtual disk, use PrlDisk_OpenDisk or PrlDisk_OpenDisk_Local. You must always free the handle using the PrlDisk_Free function when the handle is no longer needed. Failure to do so will result in memory leak.

Notes

The functionality provided by this handle offers more low-level control over new and existing virtual disks. You can use it to create standalone new disks and then decide on the virtual machine to which the disk should be connected. You can also manage existing disks, including those used by virtual machines. If, however, all you want to do is create a virtual machine and a virtual disk at the same time, or add a virtual disk to a virtual machine in a few easy steps, you can use the functionality provided by the PHT_VIRTUAL_MACHINE and PHT_VM_CONFIGURATION handles. You can also consult Virtualization SDK Programmer's Guide for a detailed explanation and code samples on how to create a new virtual machine and how to add a virtual disk to an existing virtual machine.

Functions

	Name	Description
	PrlDisk_CalcDefaultBlockSize	This function used to calculate default block size of disk
	PrlDisk_CalcSplitPartSize	Calculate the size of part of "splitted" disk in sectors.
	PrlDisk_ChangeKey	This function used to change the key of the encrypted disk
	PrlDisk_Coagulate	Combines all available disk snapshots into a single entity.
	PrlDisk_CommitUnfinishedOp	Commits unfinished state operation (interrupted).
	PrlDisk_Compact	This method is deprecated now.
	PrlDisk_CompactByBitmap	Compacts a virtual disk with free blocks map.
	PrlDisk_ConfigurePhysical	This function can be used to configure a new virtual disk, which is based on an external physical device, locally without being connected to the Parallels Service.
	PrlDisk_ConvertToCHS	This function used to convert disk size in blocks to the Cylinders-Heads-Sectors (CHS) format, used at disk creation
	PrlDisk_ConvertToCurrent	Converts virtual disks that were created with an older version of Parallels Service to the current version.
	PrlDisk_ConvertToCurrent_Local	Converts virtual disks that were created with an older version of Parallels Service to the current version.
	PrlDisk_ConvertToExtendFormat	Convert all Expanding images to Extend_Expanding
	PrlDisk_CreateDisk	Creates a new virtual disk.
	PrlDisk_CreateDisk_Local	This function can be used to create a new virtual disk locally without being connected to the Parallels Service.
	PrlDisk_CreateDiskEx	This function can be used to create a new virtual disk locally without being connected to the Parallels Service.
	PrlDisk_CreateState	Takes a snapshot of the specified virtual disk.
	PrlDisk_DecreaseCapacity	Allows to decrease the size of an existing virtual disk.
	PrlDisk_Decrypt	This function used to encrypt whole disk
	PrlDisk_DeleteState	Deletes the specified virtual disk snapshot.
	PrlDisk_Encrypt	This function used to encrypt whole disk
	PrlDisk_EstimateCompactByBitmap	Estimate compacts for a virtual disk with free blocks map.
	PrlDisk_FixConsistency	Checks and fixes consistency of a virtual disk.
	PrlDisk_FlushCache	Writes data from a virtual disk cache to the real storage.
	PrlDisk_Free	Frees the PHT_VIRTUAL_DISK handle.
	PrlDisk_GetDefaultBlockSize	This function used to get default block size of disk
	PrlDisk_GetDefaultLogicSectorSize	This function used to get default logical sector size of disk
	PrlDisk_GetDefaultPhysicalSectorSize	This function used to get default physical sector size of disk
	PrlDisk_GetDiskInfo	Obtains the information about the specified virtual disk.
	PrlDisk_GetIdentify	This function used to get HDD identify information as it shown in guest OS
	PrlDisk_GetMaxNonSplitPartSize	Get Theoretical upper limit (in sectors) after which we have to force splitted disks
	PrlDisk_GetParams	Gets virtual disk parameters.
	PrlDisk_GetSnapshotsCount	Determines the number of snapshots of the specified virtual disk.
	PrlDisk_GetSnapshotsTree	Obtains the entire snapshot tree for the specified virtual disk.
	PrlDisk_GetSplitPartSize	This function used to get splitted disk part size
	PrlDisk_GetStatesTree	Gets virtual disk states tree.
	PrlDisk_GetTemporarySnapshotUID	Get the UID of the temporary disk snapshot
	PrlDisk_GetUserParameter	Retrieves user-defined parameter values stored on a virtual disk.
	PrlDisk_IncreaseCapacity	Allows to increase the size of an existing virtual disk.
	PrlDisk_IsBootable_Local	This function used to check is the disk bootable or not
	PrlDisk_IsCompactable	Determines if the specified virtual disk can be compacted.
	PrlDisk_IsEncrypted	This function used to check is the disk encrypted or not
	PrlDisk_LinkedClone_Local	This function used to create a linked clone disk
	PrlDisk_OpenDisk	Obtains a handle of type PHT_VIRTUAL_DISK identifying an existing virtual disk.
	PrlDisk_OpenDisk_Local	Obtains a handle of type PHT_VIRTUAL_DISK identifying an existing virtual disk on a local machine.
	PrlDisk_OpenDiskEx	This function can be used to open an existing virtual disk locally without being connected to the Parallels Service.
	PrlDisk_Read	Reads data from the specified virtual disk.
	PrlDisk_ReopenWithSnapshot	Open a virtual disk at the specified snapshot.
	PrlDisk_Resize	Allows to increase or decrease the size of an existing virtual disk.
	PrlDisk_SetCachingPolicy	Set the caching policy for a virtual disk.
	PrlDisk_SetKey	This function used to set the key to the encrypted disk
	PrlDisk_SetSharedDirectory	Sets necessary access permissions on a directory containing a virtual disk to make the disk accessible to other users.
	PrlDisk_SetSharedDirectory_Local	Sets necessary access permissions on a directory containing a virtual disk to make the disk accessible to other users.
	PrlDisk_SetUserParameter	Stores user-defined parameter values on a virtual disk.
	PrlDisk_SwitchToState	Reverts a virtual disk to the specified snapshot.
	PrlDisk_WaitForCompletion	Waits for the background thread to finish executing before returning control to the client.
	PrlDisk_Write	Writes data to the specified virtual disk.

Links

Functions, Functions by Handle, Legend