Collapse All
Parallels Desktop® 10 for Mac — C API Reference Guide
ContentsIndex
PreviousUpNext
Other Structs
Enumerations  Structs, Records, Enums  Legend  Structures
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 
 
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_SERVER : SDK should working at Parallels Service application mode PAM_DESKTOP_MAC : SDK should working at Parallels Desktop for Mac application mode PAM_WORKSTATION_EXTREME : SDK should working at Parallels Workstation Extreme application mode PAM_PLAYER : SDK should working at Parallels Player application mode (not supported) PAM_DESKTOP_WL : SDK should working at Parallels Desktop for Windows/Linux application mode PAM_MOBILE : SDK should work at Parallels Mobile application mode 
 
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 
 
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

 

 
copy of CT templates functionality flags set 
 
Window corner actions 
 
 
 
CPU mode 
 
CPU mode 
 
 
 
 
 
Create image flags 
 
VM snapshot creation flags set 
 
Capabilities list 
 
CT Features 
 
 
 
Container templates types 
 
Data statistic segments 
 

  • PrlVm_DeleteSnapshotEx flags PDSF_BACKUP - delete snapshot for backup

 

 
Device in use Action 
 
Device type 
 
Format of display buffer 
 
Obsolete enum. 
 
Obsolete enum. 
 
Obsolete enum. 
 
Display(s) configuration mode 
 
 
 
VM application icon type in Dock 
 
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 
 
 
 
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

 

 
Flags which determines peer client while login to dispatcher and while attach to vm. 
 
 
 
 
 
 
 
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. 
 
Mount virtual disk flags 
 
 
 
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 
 
Printer device interface type 
 
Private event types. 
 
Parallels problem report flags functionality: PPRF_ADD_CLIENT_PART : specifies to add client information to problem report PPRF_ADD_SERVER_PART : specifies to add server information to problem report PPRF_DO_NOT_CREATE_HOST_SCREENSHOT : specifies do not create and add host screenshot to generating problem report 
 
Problem report reason enumeration 
 
Problem report scheme enumaration 
 
Problem report type enumeration 
 
Process state element 
 
Parallels license products enumeration. 
 
Proxy connection status 
 
Query element flags 
 
PrlSrv_Register3rdPartyVm command flags set 
 
PrlVm_RegEx flags 
 
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 
 
 
 
Sound channel type 
 
 
PrlVm_SwitchSnapshotEx flags 
 
Taskbar states 
 
Parallels Tools Information Service record fields 
 
Parallels Tools Information Service record states 
 
Shared Internet Applications 'open in' type PSIA_OPEN_DEFAULT : Open host link with host app; Open guest link with guest app PSIA_OPEN_IN_GUEST : Open all links with guest apps; PSIA_OPEN_IN_HOST : Open all links with host apps; 
 
Parallels Tools Utility command flags 
 
Parallels Tools Utility commands identifiers 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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 
 
USB autoconnect devices options 
 
USB device connect/disconnect reason 
 
USB device type 
 
Parallels license versions enumeration. 
 
Video 3D acceleration 
 
Virtual machine profiles enum 
 
Acceleration level 
 
Specifies virtual machine access rights. 
 
 
 
Action on VM when VM window gets closed 
 
VM autostart options 
 
VM autostop options 
 
VM backup functionality flags set 
 
Hint about the type of VE inside a backup archive 
 
VM boot order 
 
 
VM configuration sections 
 
VM device emulation type 
 
App execution result extraction moderators: PFD_STDOUT : request stdout of executed in guest OS app PFD_STDERR : request stderr of executed in guest OS app 
 
Run app in guest modes: PRPM_RUN_PROGRAM_AND_RETURN_IMMEDIATELY : just run program in guest OS and do not wait result PRPM_RUN_PROGRAM_IN_SHELL : run program via shell and in shell environment PRPM_RUN_PROGRAM_ENTER : run shell in guest 
 
VM migration functionality flags set 
 
 
 
 
 
 
 
VM normal-mode start flags: PSM_VM_START_IGNORE_HA_CLUSTER : do not register VM on HA cluster in any case (for server mode only) 
 
Background/foreground VM processes priority 
 
Parallels remote desktop modes 
 
VM start login mode 
 
VM start mode: PSM_VM_START : start VM PSM_VM_SAFE_START : start VM in the safe mode PSM_VM_START_FOR_COMPACT : start VM only for compacting disk operation 
 
 
Store value by specified keys on server options. 
 
Virtual machine tools states enumeration 
 
 
 
VM window mode 
 
Tools events, passed to the callback (see PRL_VMCTG_TOOL_DESC and PRL_TOOL_HANDLER_PTR above) 
 
VTD status code 
 
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_SERVER : SDK should working at Parallels Service application mode PAM_DESKTOP_MAC : SDK should working at Parallels Desktop for Mac application mode PAM_WORKSTATION_EXTREME : SDK should working at Parallels Workstation Extreme application mode PAM_PLAYER : SDK should working at Parallels Player application mode (not supported) PAM_DESKTOP_WL : SDK should working at Parallels Desktop for Windows/Linux application mode PAM_MOBILE : SDK should work at Parallels Mobile application mode 
 
Audio stream type 
 
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 
 
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

 

 
copy of CT templates functionality flags set 
 
Window corner actions 
 
 
 
CPU mode 
 
CPU mode 
 
 
 
 
 
Create image flags 
 
VM snapshot creation flags set 
 
Capabilities list 
 
CT Features 
 
 
 
Container templates types 
 
Data statistic segments 
 

  • PrlVm_DeleteSnapshotEx flags PDSF_BACKUP - delete snapshot for backup

 

 
Device in use Action 
 
Device type 
 
Format of display buffer 
 
Obsolete enum. 
 
Obsolete enum. 
 
Obsolete enum. 
 
Display(s) configuration mode 
 
 
 
VM application icon type in Dock 
 
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 
 
 
 
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

 

 
Specifies the reason of closing IO connection 
 
 
 
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. 
 
Mount virtual disk flags 
 
 
 
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 
 
Printer device interface type 
 
Private event types. 
 
Parallels problem report flags functionality: PPRF_ADD_CLIENT_PART : specifies to add client information to problem report PPRF_ADD_SERVER_PART : specifies to add server information to problem report PPRF_DO_NOT_CREATE_HOST_SCREENSHOT : specifies do not create and add host screenshot to generating problem report 
 
Problem report reason enumeration 
 
Problem report scheme enumaration 
 
Problem report type enumeration 
 
Process state element 
 
Parallels license products enumeration. 
 
Proxy connection status 
 
Query element flags 
 
PrlSrv_Register3rdPartyVm command flags set 
 
PrlVm_RegEx flags 
 
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 
 
 
 
Sound channel type 
 
 
PrlVm_SwitchSnapshotEx flags 
 
Taskbar states 
 
Parallels Tools Information Service record fields 
 
Parallels Tools Information Service record states 
 
Shared Internet Applications 'open in' type PSIA_OPEN_DEFAULT : Open host link with host app; Open guest link with guest app PSIA_OPEN_IN_GUEST : Open all links with guest apps; PSIA_OPEN_IN_HOST : Open all links with host apps; 
 
Parallels Tools Utility command flags 
 
Parallels Tools Utility commands identifiers 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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 
 
USB autoconnect devices options 
 
USB device connect/disconnect reason 
 
USB device type 
 
Parallels license versions enumeration. 
 
Video 3D acceleration 
 
Streaming connection status enum 
 
Virtual machine profiles enum 
 
Tools events, passed to the callback (see PRL_VMCTG_TOOL_DESC and PRL_TOOL_HANDLER_PTR above) 
 
VTD status code 
 
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 
 
Parallels API method 
 
CHS format of disk 
 
 
 
 
 
 
 
 
 
 
 
Global unique identifier 
 
 
 
 
 
 
 
Audio support since 6.6 IO protocol version. 
 
Audio support since 6.6 IO protocol version. 
 
Audio support since 6.6 IO protocol version. 
 
Audio support since 6.6 IO protocol version. 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
This struct was implemented earlier 6.3 IO protocol version but actually it was never used, so we can safely change it and use for 6.3 version. 
 
This struct was implemented earlier 6.3 IO protocol version but actually it was never used, so we can safely change it and use for 6.3 version. 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
@brief Structure that represents Parallels Tools Shared Internet Applications data

  • This structure is used to handle message of PET_IO_TOOLS_SIA_DATA type.

 

 
@brief Structure that represents Parallels Tools Utility command

  • This structure is used to handle PET_IO_TOOLS_UTILITY_COMMAND.

 

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
structure describes the object properties used by SetProperties and by PET_PTM_EVT_PROPERTY_CHANGED event 
 
structure describes object property 
 
 
 
@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

*

 

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
brief Rect as a part of region 
 
 
 
 
 
Describes the tool to be registered @see PrlVm_RegisterTool() 
 
CHS format of disk 
 
 
 
 
 
 
 
 
 
Parallels disk parameters. 
 
 
 
 
 
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() 
Links
Copyright © 1999-2015 Parallels IP Holdings GmbH and its affiliates. All rights reserved.
What do you think about this topic? Send feedback!