PHT_VIRTUAL_MACHINE

PHT_VIRTUAL_MACHINE is the main virtual machine management handle. A handle to an existing virtual machine is obtained from the PHT_JOB object returned by the PrlSrv_GetVmList function. To create a new handle, call the PrlSrv_CreateVm function.

Functions

	Name	Description
	PrlVm_Authorise	Authorises current session against encrypted virtual machine.
	PrlVm_AuthWithGuestSecurityDb	Performs an attempt to authenticate the user through the guest OS security database.
	PrlVm_BeginEdit	The PrlVm_BeginEdit function is used in modifying a virtual machine configuration.
	PrlVm_CancelCompact	Finishes process of optimization of virtual hard disk.
	PrlVm_CancelConvertDisks	Finishes process of conversion of the virtual hard disk(s).
	PrlVm_ChangePassword	Changes current password of encrypted virtual machine on new one.
	PrlVm_ChangeSid	Generates and assigns a new Windows SID to the specified virtual machine running Windows guest OS.
	PrlVm_Clone	Clones an existing virtual machine.
	PrlVm_CloneEx	Clones an existing virtual machine.
	PrlVm_Commit	The PrlVm_Commit function is used in modifying a virtual machine configuration.
	PrlVm_CommitEx	The PrlVm_CommitEx function is the same as PrlVm_Commit function but with the flags
	PrlVm_Compact	Start process of optimization of virtual hard disk.
	PrlVm_Connect	Connect to remote desktop.
	PrlVm_ConvertDisks	Start process conversion of the virtual hard disk(s).
	PrlVm_CreateCVSrc	Creates video source object.
	PrlVm_CreateEvent	Creates VM event that bint to current VM.
	PrlVm_CreateP2PTransport	Create handle of type PHT_VIDEO_RECEIVER.
	PrlVm_CreateSnapshot	Creates a virtual machine snapshot.
	PrlVm_CreateUnattendedDisk	Creates a disk image in the virtual machine home directory for unattended Windows installation.
	PrlVm_CreateUnattendedFloppy	Creates a floppy disk image in the virtual machine home directory for unattended Windows installation.
	PrlVm_Decrypt	Decrypts earlier encrypted with some secret password phrase virtual machine.
	PrlVm_Delete	Deletes the specified virtual machine from the host.
	PrlVm_DeleteSnapshot	Deleted the specified virtual machine snapshot.
	PrlVm_Disconnect	Disconnect from remote desktop.
	PrlVm_DropSuspendedState	Resets a suspended virtual machine.
	PrlVm_Encrypt	Encrypts virtual machine data using specified secret password phrase.
	PrlVm_GenerateVmDevFilename	Automatically generates a name for a virtual device which will be unique within a home directory of the specified virtual machine.
	PrlVm_GetConfig	Obtains a handle of type PHT_VM_CONFIGURATION .
	PrlVm_GetPackedProblemReport	The PrlVm_GetPackedProblemReport function obtains a Packed problem report on abnormal virtual machine termination.
	PrlVm_GetPerfStats	Obtains a handle of type PHT_EVENT containing the virtual machine performance statistics.
	PrlVm_GetProblemReport	The PrlVm_GetProblemReport function obtains a problem report on abnormal virtual machine termination.
	PrlVm_GetQuestions	The PrlVm_GetQuestions function allows to synchronously receive questions from a Parallels Service.
	PrlVm_GetSnapshotsTree	Retrieves snapshot information for the specified virtual machine.
	PrlVm_GetSnapshotsTreeEx
	PrlVm_GetState	Obtains a handle of type PHT_VM_INFO containing the specified virtual machine state and access rights information.
	PrlVm_GetStatistics	Obtains a handle of type PHT_SYSTEM_STATISTICS containing the virtual machine resource usage information, including CPU(s), memory, disk drives, processes, user session, system uptime, network packets, etc.
	PrlVm_GetStatisticsEx	The PrlVm_GetStatisticsEx function is the same as PrlVm_GetStatistics function but with the flags
	PrlVm_GetSuspendedScreen	Retrieves the virtual machine screen state before it was suspending.
	PrlVm_GetToolsState	Obtains a handle of type PHT_VM_TOOLS_INFO containing information about the state of the Parallels Tools package in a virtual machine.
	PrlVm_InitiateDevStateNotifications	This method lets to initiate sending notifications about devices states by VM.
	PrlVm_InstallTools	Begin the Parallels Tools installation process.
	PrlVm_InstallUtility	Installs a specified utility in a virtual machine.
	PrlVm_LinkedClone	Clones an existing virtual machine based on given snapshot.
	PrlVm_Lock	Lets to exclusively lock VM for current session.
	PrlVm_LoginInGuest	Creates a new console session or binds to an existing GUI session in a virtual machine.
	PrlVm_Migrate	Migrates an existing virtual machine to another host.
	PrlVm_MigrateCancel	Cancels the migration operation that was started with PrlVm_Migrate or PrlVm_MigrateEx .
	PrlVm_MigrateEx	Migrates an existing virtual machine to another host.
	PrlVm_MigrateWithRename	Migrates an existing virtual machine to another host.
	PrlVm_MigrateWithRenameEx	Migrates an existing virtual machine to another host.
	PrlVm_Mount	Mount the specified virtual machine Virtual Disks.
	PrlVm_Move	Move bundle of virtual machine or private area of container.
	PrlVm_Pause	Pauses the specified virtual machine.
	PrlVm_PtmExec	Executes an remote procedure.
	PrlVm_PtmQuery	Query object properties .
	PrlVm_PtmSet	Set object properties .
	PrlVm_PtmSubscribe	Subscribe on object properties changes.
	PrlVm_RefreshConfig	The PrlVm_RefreshConfig function updates the configuration information contained in the specified virtual machine object (handle).
	PrlVm_Reg	See also PrlVm_RegEx
	PrlVm_RegEventHandler	Registers an event handler (callback function) with the virtual machine.
	PrlVm_RegEx	Creates a new virtual machine and registers it with the Parallels Service.
	PrlVm_RemoveProtection	Removes protection from virtual machine.
	PrlVm_Reset	Resets the specified virtual machine.
	PrlVm_ResetUptime	Resets the virtual machine uptime counter (start date and counter itself).
	PrlVm_Restart	Restarts the operating system of the specified virtual machine.
	PrlVm_Restore	Restores the registered virtual machine.
	PrlVm_Resume	Resumes a virtual machine that was previously suspended with the PrlVm_Suspend call.
	PrlVm_SendClipboardRequest	@brief Requests clipboard buffer from Vm @note This call is intended to be asynchronious with possibility to be synchroneous.
	PrlVm_SetConfig	The PrlVm_SetConfig is reserved and does nothing.
	PrlVm_SetProtection	Protects virtual machine using specified secret password phrase.
	PrlVm_Start	Start the specified virtual machine.
	PrlVm_StartEx	Starts the specified virtual machine using the specified mode (see the PRL_VM_START_MODE enumeration).
	PrlVm_StartVncServer	Starts a VNC server for the specified virtual machine.
	PrlVm_Stop	Stop the specified virtual machine.
	PrlVm_StopEx	Stop the specified virtual machine.
	PrlVm_StopVncServer	Stops the VNC server that was previously started for a virtual machine.
	PrlVm_SubscribeToGuestStatistics	Subscribes to receive the specified virtual machine performance statistics on a periodic basis.
	PrlVm_SubscribeToPerfStats	Allows to subscribe to periodicaly receive virtual machine perfomance statistics.
	PrlVm_Suspend	Suspends the specified virtual machine.
	PrlVm_SwitchToSnapshot	Reverts the specified virtual machine to the specified snapshot.
	PrlVm_SwitchToSnapshotEx	Reverts the specified virtual machine to the specified snapshot.
	PrlVm_TisGetIdentifiers	Retrieves a list of identifiers from the Tools Information Service database.
	PrlVm_TisGetRecord	Obtains a handle of type PHT_TIS_RECORD containing a record from the Tools Information Service database.
	PrlVm_TisSubscribe	Subscribe on TIS database updates.
	PrlVm_TisUnsubscribe	Unsubscribe from TIS database updates.
	PrlVm_ToolsGetShutdownCapabilities	Obtains the available capabilities of a graceful virtual machine shutdown using Parallels Tools.
	PrlVm_ToolsSendShutdown	Initiates graceful shutdown of the specified virtual machine.
	PrlVm_ToolsSetTaskBarVisibility	brief Show/Hide task bar in guest.
	PrlVm_UIEmuQueryCaretInfo	Posts "get caret info" query to guest User Input Emulation tool.
	PrlVm_UIEmuQueryElementAtPos	Posts "get info on element at specified position" query to guest User Input Emulation tool.
	PrlVm_UIEmuQueryNearestElementAtPos	Posts "get info on nearest element at specified position" query to guest User Input Emulation tool.
	PrlVm_UIEmuSendClick	Send mouse click event to User Input Emulation.
	PrlVm_UIEmuSendGestureEvent	Sends a gesture event to guest User Input Emulation tool.
	PrlVm_UIEmuSendInput	Send input to guest.
	PrlVm_UIEmuSendMultimediaKey	Sends a multimedia key to guest User Input Emulation tool.
	PrlVm_UIEmuSendScroll	Send scroll event to User Input Emulation.
	PrlVm_UIEmuSendText	Send specified UTF8 text to guest User Input Emulation tool.
	PrlVm_Umount	Unmount the specified virtual machine Virtual Disks.
	PrlVm_Unlock	Lets to unlock previously locked with PrlVm_Lock call VM.
	PrlVm_Unreg	Unregisters the specified virtual machine from the Parallels Service.
	PrlVm_UnregEventHandler	Unregisters an event handler (callback function) that was previously registered using the PrlVm_RegEventHandler function.
	PrlVm_UnsubscribeFromGuestStatistics	Cancels the performance statistics subscription that was previously initiated using the PrlVm_SubscribeToGuestStatistics function.
	PrlVm_UnsubscribeFromPerfStats	Cancels the Parallels Service performance statistics subscription that was started using the PrlVm_SubscribeToPerfStats function.
	PrlVm_UpdateSecurity	Updates access level for the specified virtual machine.
	PrlVm_UpdateSnapshotData	Modifies the specified virtual machine snapshot name and description.
	PrlVm_ValidateConfig	Validates the specified section of a virtual machine configuration.

Links

Functions , Functions by Handle , Legend