Contents
Introduction
About This Guide
Organization of This Guide
How to Use This Guide
Functions by Handle
PHT_ACCESS_RIGHTS
PHT_BOOT_DEVICE
PHT_CT_TEMPLATE
PHT_DISP_CONFIG
PHT_EVENT
PHT_EVENT_PARAMETER
PHT_FIREWALL_RULE
PHT_FOUND_VM_INFO
PHT_GUEST_OSES_MATRIX
PHT_HANDLES_LIST
PHT_HW_GENERIC_DEVICE
PHT_HW_GENERIC_PCI_DEVICE
PHT_HW_HARD_DISK
PHT_HW_HARD_DISK_PARTITION
PHT_HW_NET_ADAPTER
PHT_IPPRIV_NET
PHT_JOB
PHT_LICENSE
PHT_LOGIN_RESPONSE
PHT_NET_SERVICE_STATUS
PHT_NETWORK_CLASS
PHT_NETWORK_RATE
PHT_NETWORK_SHAPING
PHT_OFFLINE_SERVICE
PHT_OPAQUE_TYPE_LIST
PHT_PLUGIN_INFO
PHT_PORT_FORWARDING
PHT_PROBLEM_REPORT
PHT_REMOTE_FILESYSTEM_ENTRY
PHT_REMOTE_FILESYSTEM_INFO
PHT_RESULT
PHT_RUNNING_TASK
PHT_SCREEN_RESOLUTION
PHT_SERVER
PHT_SERVER_CONFIG
PHT_SERVER_INFO
PHT_SHARE
PHT_STRINGS_LIST
PHT_SYSTEM_STATISTICS
PHT_SYSTEM_STATISTICS_CPU
PHT_SYSTEM_STATISTICS_DISK
PHT_SYSTEM_STATISTICS_DISK_PARTITION
PHT_SYSTEM_STATISTICS_IFACE
PHT_SYSTEM_STATISTICS_PROCESS
PHT_SYSTEM_STATISTICS_USER_SESSION
PHT_UIEMU_INPUT
PHT_USB_IDENTITY
PHT_USER_INFO
PHT_USER_PROFILE
PHT_VIRTUAL_DEV_FLOPPY
PHT_VIRTUAL_DEV_HARD_DISK
PHT_VIRTUAL_DEV_HD_PARTITION
PHT_VIRTUAL_DEV_NET_ADAPTER
PHT_VIRTUAL_DEV_OPTICAL_DISK
PHT_VIRTUAL_DEV_PARALLEL_PORT
PHT_VIRTUAL_DEV_SERIAL_PORT
PHT_VIRTUAL_DEV_SOUND
PHT_VIRTUAL_DEV_USB_DEVICE
PHT_VIRTUAL_DISK
PHT_VIRTUAL_MACHINE
PHT_VIRTUAL_NETWORK
PHT_VM_CONFIGURATION
PHT_VM_GUEST_SESSION
PHT_VM_INFO
PHT_VM_TOOLS_INFO
PHT_VM_VIRTUAL_DEVICES_INFO
Common Functions
System Functions
API Debug Functions
Handle Functions
Virtual Device Functions
PrlBuffer
Remote Desktop Access
Primary Display Capture
Secondary Display Capture
Keyboard Control
Mouse Control
Callback Prototypes
PRL_DISK_CALLBACK
PRL_EVENT_HANDLER_PTR
PRL_STATES_CALLBACK
Types
PRL_BOOL Types
PRL_CHAR Types
PRL_CONST Types
PRL_DEVICE Types
PRL_DISK Types
PRL_DOUBLE Types
PRL_FILE Types
PRL_INT Types
PRL_IO Types
PRL_TIS Types
PRL_TOOLS Types
PRL_UINT Types
PRL_VM Types
PRL_CHS_PTR Type
PRL_CONST_GET_VM_CONFIG_PARAM_DATA_PTR Type
PRL_CONST_IOLIMIT_DATA_PTR Type
PRL_VOID Types
PRL_CONST_UIEMU_ELEMENT_AT_POS_PTR Type
Other Types
PRL_CONST_UIEMU_VKEY_PTR Type
PRL_CT_TEMPLATE_TYPE_PTR Type
PRL_DISTRO_MEDIA_TYPE_PTR Type
PRL_EDIT_VM_FLAGS_PTR Type
PRL_ENCRYPTION_FLAGS_PTR Type
PRL_FEATURES_MATRIX_PTR Type
PRL_FIREWALL_POLICY_PTR Type
PRL_GET_VM_CONFIG_PARAM_DATA_PTR Type
PRL_IO_AUDIO_DATA_PTR Type
PRL_IO_AUDIO_ENCODING_LIST_PTR Type
PRL_IO_AUDIO_ENCODING_PTR Type
PRL_IO_AUDIO_ENCODING_RESPONSE_PTR Type
PRL_IOLIMIT_DATA_PTR Type
PRL_PRINTER_INTERFACE_TYPE_PTR Type
PRL_REGISTER_3PARTY_VM_FLAGS_PTR Type
PRL_UIEMU_ELEMENT_AT_POS_PTR Type
PRL_UIEMU_ELEMENT_CONTROL_TYPE_PTR Type
PRL_UIEMU_VKEY_PTR Type
Structs, Records, Enums
PRL_IO Structs
PRL_VM Structs
_PRL_CHS Structure
_PRL_COPY_CT_TEMPLATE_FLAGS Enumeration
_PRL_CT_RESOURCE Enumeration
_PRL_CT_TEMPLATE_TYPE Enumeration
_PRL_DISTRO_MEDIA_TYPE Enumeration
_PRL_EDIT_VM_FLAGS Enumeration
_PRL_ENCRYPTION_FLAGS Enumeration
Other Structs
_PRL_FEATURES_MATRIX Enumeration
_PRL_FIREWALL_POLICY Enumeration
_PRL_GET_SNAPSHOT_TREE_FLAGS Enumeration
_PRL_GET_VM_CONFIG_PARAM_DATA Structure
_PRL_IO_AUDIO_DATA Structure
_PRL_IO_AUDIO_ENCODING Structure
_PRL_IO_AUDIO_ENCODING_LIST Structure
_PRL_IO_AUDIO_ENCODING_RESPONSE Structure
_PRL_IO_CLIENT_FLAGS Enumeration
_PRL_IOLIMIT_DATA Structure
_PRL_IOLIMIT_TYPE Enumeration
_PRL_ISCSI_STORAGE_CMD_FLAGS Enumeration
_PRL_ISCSI_STORAGE_FSTYPE_FLAGS Enumeration
_PRL_MOUNT_VIRTUAL_DISK Enumeration
_PRL_PRINTER_INTERFACE_TYPE Enumeration
_PRL_REGISTER_3PARTY_VM_FLAGS Enumeration
_PRL_UIEMU_ELEMENT_AT_POS Structure
_PRL_UIEMU_ELEMENT_CONTROL_TYPE Enumeration
_PRL_UIEMU_VKEY Structure
_PRL_VM_COMMIT_FLAGS Enumeration
_PRL_VM_STORE_VALUE_FLAGS Enumeration
_PRL_VM_TYPE_FLAGS Enumeration
PRL_CHS Structure
PRL_COPY_CT_TEMPLATE_FLAGS Enumeration
PRL_CT_RESOURCE Enumeration
PRL_CT_TEMPLATE_TYPE Enumeration
PRL_DISTRO_MEDIA_TYPE Enumeration
PRL_EDIT_VM_FLAGS Enumeration
PRL_ENCRYPTION_FLAGS Enumeration
PRL_FEATURES_MATRIX Enumeration
PRL_FIREWALL_POLICY Enumeration
PRL_GET_SNAPSHOT_TREE_FLAGS Enumeration
PRL_GET_VM_CONFIG_PARAM_DATA Structure
PRL_IO_AUDIO_DATA Structure
PRL_IO_AUDIO_ENCODING Structure
PRL_IO_AUDIO_ENCODING_LIST Structure
PRL_IO_AUDIO_ENCODING_RESPONSE Structure
PRL_IO_CLIENT_FLAGS Enumeration
PRL_IOLIMIT_DATA Structure
PRL_IOLIMIT_TYPE Enumeration
PRL_ISCSI_STORAGE_CMD_FLAGS Enumeration
PRL_ISCSI_STORAGE_FSTYPE_FLAGS Enumeration
PRL_MOUNT_VIRTUAL_DISK Enumeration
PRL_PRINTER_INTERFACE_TYPE Enumeration
PRL_REGISTER_3PARTY_VM_FLAGS Enumeration
PRL_UIEMU_ELEMENT_AT_POS Structure
PRL_UIEMU_ELEMENT_CONTROL_TYPE Enumeration
PRL_UIEMU_VKEY Structure
PRL_VM_COMMIT_FLAGS Enumeration
PRL_VM_STORE_VALUE_FLAGS Enumeration
PRL_VM_TYPE_FLAGS Enumeration
Macros
GUI_ERR Macros
PET Macros
PRL_DISK Macros
PRL_ERR Macros
PRL_SCAN_CODE Macros
PVS_GUEST Macros
GUI_INFO_APPS_FOLDER_ADDED_TO_DOCK Macro
GUI_INFO_APPS_FOLDER_REMOVED_FROM_DOCK Macro
GUI_INFO_APPS_FOLDER_REMOVED_FROM_DOCK_NO_VM Macro
GUI_INFO_APPS_FOLDER_UPDATED_IN_DOCK Macro
GUI_INFO_BLUETOOTH_USB_CONTROLLER_CONNECT_TO_VM Macro
GUI_INFO_CTRL_ALT_DEL_PRESSED Macro
GUI_INFO_ISIGHT_CAMERA_CONNECT_TO_VM Macro
Other Macros
GUI_WRN_AUTOPLAY_CD_NOT_PRESENT_IN_CONFIGURATION Macro
PET_ANSWER_RETRY Macro
PET_QUESTION_CANCEL_CONVERT_3RD_VM_OPERATION Macro
PET_QUESTION_COMMON_HDD_ERROR Macro
PRL_DISK_IGNORE_PROTECTION Macro
PRL_ERR_AUDIO_ENCODINGS_NOT_SUPPORTED Macro
PRL_ERR_BACKUP_CT_ID_ALREADY_EXIST Macro
PRL_ERR_BACKUP_TOOL_CANNOT_START Macro
PRL_ERR_CANNOT_EDIT_FIREWALL_AT_TRANS_VM_STATE Macro
PRL_ERR_CANNOT_EDIT_HARDWARE_FOR_PAUSED_VM Macro
PRL_ERR_CANT_CHANGE_DEFAULT_PLUGIN_BY_NON_ADMIN Macro
PRL_ERR_CANT_CONVERT_CONFIG Macro
PRL_ERR_CANT_CONVERT_OTHER_VENDOR_HDD Macro
PRL_ERR_CANT_CONVERT_OTHER_VENDOR_VM Macro
PRL_ERR_CANT_PREPARE_RECONFIG_DATA Macro
PRL_ERR_CANT_RECONFIG_GUEST_OS Macro
PRL_ERR_CANT_SET_DEFAULT_ENCRYPTION_PLUGIN Macro
PRL_ERR_CANT_SET_DEFAULT_ENCRYPTION_PLUGIN_BY_WRONG_FORMAT Macro
PRL_ERR_CANT_UNPACK_ARCHIVE Macro
PRL_ERR_CI_CANNOT_COPY_IMAGE_NON_STOPPED_VM Macro
PRL_ERR_CI_DEVICE_IS_NOT_VIRTUAL Macro
PRL_ERR_CI_PERMISSIONS_DENIED Macro
PRL_ERR_CONNECT_TO_MOUNTER Macro
PRL_ERR_CONVERT_NO_GUEST_OS_FOUND Macro
PRL_ERR_COPY_CT_TMPL_INTERNAL_ERROR Macro
PRL_ERR_COULD_NOT_START_FIREWALL_TOOL Macro
PRL_ERR_CREATE_HARD_DISK_WITH_ZERO_SIZE Macro
PRL_ERR_CT_MIGRATE_INTERNAL_ERROR Macro
PRL_ERR_CT_NOT_FOUND Macro
PRL_ERR_DISK_GPT_MBR_NOT_EQUAL Macro
PRL_ERR_DISK_XML_DIFFERS_FROM_REAL Macro
PRL_ERR_DISK_XML_PARTITION_NOT_FOUND Macro
PRL_ERR_ENC_DISABLE_PLUGINS_NOT_PERMITTED Macro
PRL_ERR_ENC_ENABLE_PLUGINS_NOT_PERMITTED Macro
PRL_ERR_ENC_PLUGIN_UUID_NOT_FOUND Macro
PRL_ERR_ENC_PLUGINS_FEATURE_IS_ALREADY_DISABLED Macro
PRL_ERR_ENC_PLUGINS_FEATURE_IS_ALREADY_ENABLED Macro
PRL_ERR_ENC_PLUGINS_FEATURE_IS_DISABLED Macro
PRL_ERR_ENC_PLUGINS_UNABLE_LOAD_DIR_ALREADY Macro
PRL_ERR_ENC_RESCAN_PLUGINS_NOT_PERMITTED Macro
PRL_ERR_ENC_UNABLE_UNLOAD_PLUGINS_IN_USE Macro
PRL_ERR_FIREWALL_TOOL_EXECUTED_WITH_ERROR Macro
PRL_ERR_IMPORT_BOOTCAMP_VM_NO_SPACE Macro
PRL_ERR_INVALID_MEMORY_GUARANTEE Macro
PRL_ERR_INVALID_MEMORY_QUOTA Macro
PRL_ERR_INVALID_TOTAL_LIMIT Macro
PRL_ERR_ISCSI_STORAGE_ALREADY_REGISTERED Macro
PRL_ERR_ISCSI_STORAGE_CANNOT_CREATE_MOUNT_POINT Macro
PRL_ERR_ISCSI_STORAGE_CREATE Macro
PRL_ERR_ISCSI_STORAGE_EXTEND Macro
PRL_ERR_ISCSI_STORAGE_GET_STATE Macro
PRL_ERR_ISCSI_STORAGE_INVALID_FSTYPE Macro
PRL_ERR_ISCSI_STORAGE_LIBRARY Macro
PRL_ERR_ISCSI_STORAGE_MOUNT Macro
PRL_ERR_ISCSI_STORAGE_MOUNT_POINT_ALREADY_EXISTS Macro
PRL_ERR_ISCSI_STORAGE_MOUNTED Macro
PRL_ERR_ISCSI_STORAGE_NOT_FOUND Macro
PRL_ERR_ISCSI_STORAGE_NOT_MOUNTED Macro
PRL_ERR_ISCSI_STORAGE_NOT_SUPPORTED Macro
PRL_ERR_ISCSI_STORAGE_REMOVE Macro
PRL_ERR_ISCSI_STORAGE_START Macro
PRL_ERR_ISCSI_STORAGE_UMOUNT Macro
PRL_ERR_IT_CANT_COMPACT Macro
PRL_ERR_IT_CANT_COMPACT_LDM_DISK Macro
PRL_ERR_IT_CANT_COMPACT_PLAIN_DISK Macro
PRL_ERR_IT_CANT_GET_BITMAP Macro
PRL_ERR_IT_CANT_GET_PARAMS_FROM_OLD_IMAGE Macro
PRL_ERR_IT_CANT_OPEN_IMAGE Macro
PRL_ERR_IT_CANT_PREPARE_RECONFIG_DATA Macro
PRL_ERR_IT_CANT_RECONFIG Macro
PRL_ERR_IT_CANT_RECONFIG_BOOTCAMP Macro
PRL_ERR_IT_CANT_RESIZE_LDM_DISK Macro
PRL_ERR_IT_CANT_RESIZE_VOLUME Macro
PRL_ERR_IT_CANT_VALIDATE_BOOTCAMP Macro
PRL_ERR_IT_CONVERT_TO_CURRENT_ERROR Macro
PRL_ERR_IT_DISK_SMALL_FOR_SPLIT Macro
PRL_ERR_IT_FAST_RESIZE_FAILURE Macro
PRL_ERR_IT_FIRST_ERROR Macro
PRL_ERR_IT_FIRST_FAILURE Macro
PRL_ERR_IT_FS_NOT_SUPPORTED_FOR_RESIZE Macro
PRL_ERR_IT_GUEST_TOOLS_UNKNOWN_STATE Macro
PRL_ERR_IT_HAL_NOT_FOUND Macro
PRL_ERR_IT_RECONFIG_PATH_NEEDED Macro
PRL_ERR_IT_ROLLBACK_FAILURE Macro
PRL_ERR_IT_SIZE_CHANGED Macro
PRL_ERR_IT_SNAPSHOTS_MERGE_IS_NEEDED Macro
PRL_ERR_IT_UNKNOWN_OS Macro
PRL_ERR_IT_USER_INTERRUPTED Macro
PRL_ERR_LICENSE_BLACKLISTED_TO_VM_OPERATION Macro
PRL_ERR_LOW_MEMORY_LIMIT Macro
PRL_ERR_MOUNTER_LIST_NO_OBJECT Macro
PRL_ERR_MSG_START_32BIT_VM_ON_64BIT_HOST Macro
PRL_ERR_NO_GUEST_OS_FOUND Macro
PRL_ERR_OBJECT_BAD_INTERFACE Macro
PRL_ERR_OBJECT_DUPLICATE_UID Macro
PRL_ERR_OBJECT_LIB_CANT_GET_PERMS Macro
PRL_ERR_OBJECT_LIB_LOAD_ERROR Macro
PRL_ERR_OBJECT_LIB_NO_FUNCTIONS Macro
PRL_ERR_OBJECT_LIB_WRONG_PERMS Macro
PRL_ERR_ONLY_ADMIN_CAN_SET_VERBOSE_LOGGING Macro
PRL_ERR_OS_RECONFIG_DATA_ABSENT Macro
PRL_ERR_PERFORM_MOUNTER_COMMAND Macro
PRL_ERR_SET_CPUMASK Macro
PRL_ERR_SET_DEFAULT_ENCRYPTION_PLUGIN_FEATURE_DISABLED Macro
PRL_ERR_SET_IOLIMIT Macro
PRL_ERR_SOURCE_ISNT_BOOTCAMP_DISK Macro
PRL_ERR_START_VM_BY_NOT_AUTH_USER Macro
PRL_ERR_START_VM_BY_NOT_DEFINED_USER Macro
PRL_ERR_SUSPEND_BOOTCAMP_NOT_NTFS_ONLY_DISK Macro
PRL_ERR_SUSPEND_BOOTCAMP_NTFS_RW_MOUNTERS_DETECTED Macro
PRL_ERR_TEMPLATE_HAS_APPS Macro
PRL_ERR_TEMPLATE_NOT_FOUND Macro
PRL_ERR_UNABLE_APPLY_MEMORY_GUARANTEE Macro
PRL_ERR_UNABLE_APPLY_TOTAL_LIMIT Macro
PRL_ERR_UNABLE_TO_CLEANUP_BROKEN_TRANSACTIONS Macro
PRL_ERR_UNABLE_TO_COMMIT_BROKEN_TRANSACTION Macro
PRL_ERR_UNABLE_TO_ROLLBACK_BROKEN_TRANSACTION Macro
PRL_ERR_UNSUPPORTED_LAYOUTS_STRUCTURE Macro
PRL_ERR_UNSUPPORTED_VIRTUAL_SOURCE Macro
PRL_ERR_VM_HDD_DISCONNECT_FAILED_LOCKED Macro
PRL_ERR_VM_LOCKED_FOR_CHANGE_FIREWALL Macro
PRL_ERR_VM_LOCKED_FOR_COPY_IMAGE Macro
PRL_ERR_VM_MIGRATE_BREAK_BY_DISK_CONDITION Macro
PRL_ERR_VM_MIGRATE_CANNOT_REMOTE_CLONE_SHARED_VM Macro
PRL_ERR_VM_MIGRATE_CONTINUE_START_FAILED Macro
PRL_ERR_VM_MIGRATE_REGISTER_VM_FAILED Macro
PRL_ERR_VM_MIGRATE_RESUME_VM_FAILED Macro
PRL_ERR_VM_MIGRATE_STORAGE_INFO_PARSE Macro
PRL_ERR_VM_MIGRATE_SUSPEND_VM_FAILED Macro
PRL_ERR_VM_MIGRATE_VM_ALREADY_MIGRATE_ON_TARGET Macro
PRL_ERR_VM_MOUNT Macro
PRL_ERR_VM_TOOL_NOT_AVAILABLE Macro
PRL_ERR_VM_UNMOUNT Macro
PRL_ERR_VMCONF_CD_DVD_ROM_SET_SATA_FOR_OLD_CHIPSET Macro
PRL_ERR_VMCONF_CD_DVD_ROM_SET_SATA_FOR_UNSUPPORTED_OS Macro
PRL_ERR_VMCONF_CPU_MASK_INVALID Macro
PRL_ERR_VMCONF_CPU_MASK_INVALID_CPU_NUM Macro
PRL_ERR_VMCONF_HARD_DISK_SET_SATA_FOR_OLD_CHIPSET Macro
PRL_ERR_VMCONF_HARD_DISK_SET_SATA_FOR_UNSUPPORTED_OS Macro
PRL_ERR_VMCONF_IOLIMIT_NOT_SUPPORTED Macro
PRL_ERR_VMCONF_SATA_DEVICES_COUNT_OUT_OF_RANGE Macro
PRL_ERR_VMCONF_SATA_DEVICES_DUPLICATE_STACK_INDEX Macro
PRL_ERR_VOLUME_LICENSE_EXCEEDED_LIMIT Macro
PRL_ERR_VZ_API_NOT_INITIALIZED Macro
PRL_ERR_VZ_OPERATION_FAILED Macro
PRL_ERR_VZ_OSTEMPLATE_NOT_FOUND Macro
PRL_ERR_WRONG_CIPHER_ID_FORMAT_IN_CONFIG Macro
PRL_HDD_FIRMWARE_LEN Macro
PRL_HDD_MODEL_LEN Macro
PRL_HDD_SERIAL_LEN Macro
PRL_IO_MAX_AUDIO_ENCODINGS Macro
PRL_NET_DUPLICATE_IPPRIVATE_NETWORK_NAME Macro
PRL_NET_IPPRIVATE_NETWORK_DOES_NOT_EXIST Macro
PRL_NET_IPPRIVATE_NETWORK_INVALID_IP Macro
PRL_NET_VALID_DHCP_RANGE_WRONG_IP_ADDRS Macro
PRL_NET_VALID_DHCP_SCOPE_RANGE_LESS_MIN Macro
PRL_NET_VALID_FAILURE Macro
PRL_NET_VALID_MISMATCH_DHCP_SCOPE_MASK Macro
PRL_NET_VALID_WRONG_DHCP_IP_ADDR Macro
PRL_NET_VALID_WRONG_HOST_IP_ADDR Macro
PRL_NET_VALID_WRONG_NET_MASK Macro
PRL_NET_VIRTUAL_NETWORK_SHARED_PROHIBITED Macro
PRL_QUESTION_CONVERT_VM_CANT_DETECT_OS Macro
PRL_TERNARY_FALSE Macro
PRL_TERNARY_TRUE Macro
PRL_TERNARY_UNDEF Macro
PRL_WARN_LINK_TO_OUTSIDED_HDD_WILL_BE_DROPPED_AFTER_CLONE Macro
PRL_WARN_OUTSIDED_HDD_WILL_BE_ONLY_LINKED_AFTER_CLONE Macro
PRL_WARN_UNABLE_OPEN_DEVICE_ON_START_VM Macro
PRL_WARN_VM_DISCONNECT_SATA_HDD Macro
PRL_WRN_IT_CANT_RESIZE_LDM_DISK Macro
PRL_WRN_IT_CANT_RESIZE_VOLUME Macro
PRL_WRN_IT_EMPTY_MBR Macro
PRL_WRN_IT_FIRST_WARNING Macro
PRL_WRN_IT_VOLUME_RESIZING Macro
PVS_GUEST_VER_BSD_8X Macro
PVS_GUEST_VER_NAME_BSD_8X Macro
PVS_GUEST_VER_NAME_SOL_OPEN Macro
PVS_GUEST_VER_SOL_OPEN Macro
Copyright © 1999-2010 Parallels Holdings, Ltd. and its affiliates. All rights reserved.
Contents
|
Index