Collapse All
Parallels Virtualization SDK
Other Structs
Enumerations Structs, Records, Enums Legend Structures Types
Enumerations
Name
Description
Parallels adapter index reserved values: PAI_INVALID_ADAPTER: parallels adapter in general is not available PAI_GENERATE_INDEX: calculate a new parallels adapter index
Allowed vm commands enumeration
VM application in Dock mode
Appliance download status
Parallels application mode in which SDK should work PAM_DESKTOP_MAC : SDK should working at Parallels Desktop for Mac application mode PAM_MOBILE : SDK should work at Parallels Mobile application mode
Battery enter conditions
Battery quit conditions
BIOS type
PrlVm_CloneEx command flags set
PCVF_DETACH_EXTERNAL_VIRTUAL_HDD
  • to remove link to Virtual Hdd which located outside of VM.pvm directory from cloned vm configuration.

Clustered device subtype
Compact mode: PCM_COMPACT_WITH_HARD_DISKS_INFO : show question before compacting with size disks info PCM_HARD_DISKS_INFO : just get disk info PCM_FULL_CLEAN_UP_VM : compact all disks and delete all unneccessary files PCM_COMPACT_SHUTDOWN_VM : shutdown running vm (w/o questions) before compact and start it after finish
Convert virtual disk
  • PCVD_CANCEL : cancel disk conversion
  • PCVD_TO_PLAIN_DISK : convert disk from expanding to plain disk
  • PCVD_TO_EXPANDING_DISK : convert disk from plain to expanding disk
  • PCVD_TO_SPLIT_DISK : convert disk from non-split to split disk
  • PCVD_TO_NON_SPLIT_DISK : convert disk from split to non-split disk
  • PCVD_MERGE_ALL_SNAPSHOTS : merge all disk snapshots

Window corner actions
Create image flags
VM snapshot creation flags set
Container templates types
Data statistic segments
  • PrlVm_DeleteSnapshotEx flags PDSF_BACKUP - delete snapshot for backup

Device in use Action
Device type
VM application icon type in Dock
Parallels license edition enumeration.
Encryption operations: Uses for PrlVm_Encrypt () / PrlVm_Decrypt operations
Event issuer type
Different event types are identified by these event codes.
External VM type for supporting native VM
Features matrix list
File system element type
File system general type
Firewall direction
Firewall policy
Generic device state PGS_CONNECTED_TO_HOST : device is used by host PGS_CONNECTED_TO_VM : device is used by VM PGS_RESERVED : reserved value PGS_NON_CONTROLLED_USB : USB device is not controlled PGS_CONNECTING_TO_VM : device belong to VM, but prl_usb_dev still not started
Generic PCI device class: PGD_PCI_NETWORK : generic PCI network device PGD_PCI_DISPLAY : generic PCI display device PGD_PCI_SOUND : generic PCI sound device PGD_PCI_OTHER : another generic PCI device
Find VM operations:
List operations: Uses for PrlSrv_GetVmListEx operation
Graceful Shutdown types
Windows installation distributive type.
The _PRL_HANDLE_TYPE enumeration defines handle types.
Hard disk interfce mask enum
Hard disk image type
Host OS type
Network adapter types in hardware info list
Hypervisor types
Install appliance options
  • PIAF_CANCEL : cancel appliance installation
  • PIAF_FORCE : do not cancel installation and begin a new one
  • if the previous installation became corrupted outside.
  • PIAF_STOP : temporary stop appliance downloading

iSCSI storage management flags
iSCSI storage filesystem type
Job operation codes
Job status enumeration
Parallels virtual keycodes.
License restriction options
Mass storage device interface type
Message type enumeration.
Authorization mode, when mobile client establishing remote access to the host.
Network adapter emulated type
Virtual Network type.
Netfilter modes list
Online compact mode for virtual machine disks
Determines the mode of modifiers handling inside the guest
Event parameters fields types
Port forwarding type: PPF_TCP : TCP port forwarding PPF_UDP : UDP port forwarding
Power scheme sleep ability possible values
Printer device interface type
Private event types.
Process state element
Parallels license products enumeration.
Query element flags
PrlSrv_Register3rdPartyVm command flags set
PrlSrv_RegisterVmEx command flags set
PrlVmDev_ResizeImage command flags set
Running task type enumeration.
Aspect ratio mode
Security level enumeration.
Serial port operation mode when on socket
Parallels service statuses
File sharing item access mode mask
File sharing item flags
Last shutdown reason
Sound channel type
Startup and shutdown virtual machine profile types
PrlVm_SwitchSnapshotEx flags
Taskbar states
Parallels Tools Information Service record fields
Parallels Tools Information Service record states
VM undo disks mode: PUD_DISABLE_UNDO_DISKS : disbale undo disks PUD_REVERSE_CHANGES : at stopping VM revert all disk changes PUD_COMMIT_CHANGES : at stopping VM apply all disk changes PUD_PROMPT_BEHAVIOUR : ask user which mode reverse or commit will be applied
Update/Install license operations: Uses for PrlSrv_UpdateLicenseEx operation
Parallels license versions enumeration.
Video 3D acceleration
Virtual machine profiles enum
Virtual network adapter profiles enum
Tools events, passed to the callback (see PRL_VMCTG_TOOL_DESC and PRL_TOOL_HANDLER_PTR above)
VTD status code
Windows maintenance schedule day or days
Window corners
Edges where taskbar can be placed (in coherence mode).
Virtual machine addition states enumeration, may be combined with bitwise
Virtual machine states enumeration
Parallels adapter index reserved values: PAI_INVALID_ADAPTER: parallels adapter in general is not available PAI_GENERATE_INDEX: calculate a new parallels adapter index
Allowed vm commands enumeration
Common operations flags set.
Parallels API initialization flags: PrlApi_InitEx command flags set PAIF_USE_GRAPHIC_MODE : specifies create SDK session which has access to the graphic mode
VM application in Dock mode
Appliance download status
Parallels application mode in which SDK should work PAM_DESKTOP_MAC : SDK should working at Parallels Desktop for Mac application mode PAM_MOBILE : SDK should work at Parallels Mobile application mode
Audio stream type
Backup file kinds
Backup file types
Backup file levels
Backup options
Battery enter conditions
Battery quit conditions
BIOS type
PrlVm_CloneEx command flags set
PCVF_DETACH_EXTERNAL_VIRTUAL_HDD
  • to remove link to Virtual Hdd which located outside of VM.pvm directory from cloned vm configuration.

Clustered device subtype
Compact mode: PCM_COMPACT_WITH_HARD_DISKS_INFO : show question before compacting with size disks info PCM_HARD_DISKS_INFO : just get disk info PCM_FULL_CLEAN_UP_VM : compact all disks and delete all unneccessary files PCM_COMPACT_SHUTDOWN_VM : shutdown running vm (w/o questions) before compact and start it after finish
Convert virtual disk
  • PCVD_CANCEL : cancel disk conversion
  • PCVD_TO_PLAIN_DISK : convert disk from expanding to plain disk
  • PCVD_TO_EXPANDING_DISK : convert disk from plain to expanding disk
  • PCVD_TO_SPLIT_DISK : convert disk from non-split to split disk
  • PCVD_TO_NON_SPLIT_DISK : convert disk from split to non-split disk
  • PCVD_MERGE_ALL_SNAPSHOTS : merge all disk snapshots

Window corner actions
Create image flags
VM snapshot creation flags set
Container templates types
Data statistic segments
  • PrlVm_DeleteSnapshotEx flags PDSF_BACKUP - delete snapshot for backup

Device in use Action
Device type
VM application icon type in Dock
Parallels license edition enumeration.
Encryption operations: Uses for PrlVm_Encrypt () / PrlVm_Decrypt operations
Event issuer type
Different event types are identified by these event codes.
External VM type for supporting native VM
Features matrix list
File system element type
File system general type
Firewall direction
Firewall policy
Generic device state PGS_CONNECTED_TO_HOST : device is used by host PGS_CONNECTED_TO_VM : device is used by VM PGS_RESERVED : reserved value PGS_NON_CONTROLLED_USB : USB device is not controlled PGS_CONNECTING_TO_VM : device belong to VM, but prl_usb_dev still not started
Generic PCI device class: PGD_PCI_NETWORK : generic PCI network device PGD_PCI_DISPLAY : generic PCI display device PGD_PCI_SOUND : generic PCI sound device PGD_PCI_OTHER : another generic PCI device
Find VM operations:
List operations: Uses for PrlSrv_GetVmListEx operation
Graceful Shutdown types
Windows installation distributive type.
The _PRL_HANDLE_TYPE enumeration defines handle types.
Hard disk interfce mask enum
Hard disk image type
Host OS type
Network adapter types in hardware info list
Hypervisor types
Install appliance options
  • PIAF_CANCEL : cancel appliance installation
  • PIAF_FORCE : do not cancel installation and begin a new one
  • if the previous installation became corrupted outside.
  • PIAF_STOP : temporary stop appliance downloading

iSCSI storage management flags
iSCSI storage filesystem type
Job operation codes
Job status enumeration
Parallels virtual keycodes.
License restriction options
Mass storage device interface type
Message type enumeration.
Authorization mode, when mobile client establishing remote access to the host.
Network adapter emulated type
Virtual Network type.
Netfilter modes list
Online compact mode for virtual machine disks
Determines the mode of modifiers handling inside the guest
Event parameters fields types
Port forwarding type: PPF_TCP : TCP port forwarding PPF_UDP : UDP port forwarding
Power scheme sleep ability possible values
Printer device interface type
Private event types.
Process state element
Parallels license products enumeration.
Query element flags
PrlSrv_Register3rdPartyVm command flags set
PrlSrv_RegisterVmEx command flags set
PrlVmDev_ResizeImage command flags set
Running task type enumeration.
Aspect ratio mode
Security level enumeration.
Serial port operation mode when on socket
Parallels service statuses
File sharing item access mode mask
File sharing item flags
Last shutdown reason
Sound channel type
Startup and shutdown virtual machine profile types
PrlVm_SwitchSnapshotEx flags
Taskbar states
Parallels Tools Information Service record fields
Parallels Tools Information Service record states
VM undo disks mode: PUD_DISABLE_UNDO_DISKS : disbale undo disks PUD_REVERSE_CHANGES : at stopping VM revert all disk changes PUD_COMMIT_CHANGES : at stopping VM apply all disk changes PUD_PROMPT_BEHAVIOUR : ask user which mode reverse or commit will be applied
Update/Install license operations: Uses for PrlSrv_UpdateLicenseEx operation
Parallels license versions enumeration.
Virtual machine profiles enum
Virtual network adapter profiles enum
Tools events, passed to the callback (see PRL_VMCTG_TOOL_DESC and PRL_TOOL_HANDLER_PTR above)
VTD status code
Windows maintenance schedule day or days
Window corners
Edges where taskbar can be placed (in coherence mode).
Virtual machine addition states enumeration, may be combined with bitwise
Virtual machine states enumeration
Structures
Name
Description
Parallels disk parameters.
Parallels storage parameters
Parallels snapshot tree element
Information about encryption plugin
Generic information about plugin
CHS format of disk
Global unique identifier
@brief Structure that is used in TIS to represent internal versions
  • TIS - Tools Information Service

*

@brief Fixed size information about TIS record
  • TIS - Tools Information Service

*

@brief Structure that is used in TIS to represent versions *
  • TIS - Tools Information Service

*

Describes the tool to be registered @see PrlVm_RegisterTool ()
Information about encryption plugin
Generic information about plugin
Parallels API method
CHS format of disk
Parallels disk parameters.
Global unique identifier
Parallels storage parameters
Parallels snapshot tree element
@brief Structure that is used in TIS to represent internal versions
  • TIS - Tools Information Service

*

@brief Fixed size information about TIS record
  • TIS - Tools Information Service

*

@brief Structure that is used in TIS to represent versions *
  • TIS - Tools Information Service

*

Describes the tool to be registered @see PrlVm_RegisterTool ()
Types
Name
Description
Encryption interface
Base interface
Links
Copyright © 1999-2017 Parallels International GmbH. All rights reserved.