PrlApi.h
This file is the part of parallels public SDK library.
Copyright (c) 2005-2008 Parallels Software International, Inc. All rights reserved. http://www.parallels.com
|
Name |
Description |
|
This inline function returns a readable string representation of the specified event type. | |
|
This inline function returns a readable string representation of the specified handle type. | |
|
This inline function returns a readable string representation of the PRL_RESULT value. | |
|
Obtains the virtual machine access rights information. | |
|
Determines the virtual machine owner name. | |
|
Determines if the current user is authorized to perform a specified task on a virtual machine. | |
|
Determines if the current user is the owner of the specified virtual machine. | |
|
Sets access rights on a virtual machine. | |
|
Adds buffer to the remote command. | |
|
Adds unsigned int parameter to the command. | |
|
Creates SDK object represents handles list | |
|
Creates a new handle of type PHT_OPAQUE_TYPE_LIST. | |
|
| |
|
Creates command to the remote device. | |
|
Creates a handle of type PHT_STRINGS_LIST. | |
|
De-initializes the library. | |
|
Returns the Parallels API application mode. | |
|
Returns the path to Parallels crash dumps storing directory. | |
|
Returns default guest OS version for specified guest OS type at current API mode (see PrlApi_InitEx for more info about API mode). | |
|
Evaluates the specified error code and returns its classification (warning, question, information, etc.). | |
|
The PrlApi_GetRecommendMinVmMem returns recommend minimal memory size for guest OS defined in the OS version parameter. | |
|
| |
|
| |
|
| |
|
| |
|
Obtains current registration of the remote devices of specified type | |
|
Evaluates a return code and returns a description of the problem. | |
|
Returns handle of type PHT_OPAQUE_TYPE_LIST which contains supported guest OSes types list for current API mode (see PrlApi_InitEx for more info about API mode). | |
|
Returns handle of type PHT_OPAQUE_TYPE_LIST which contains supported guest OSes list for specified guest OS type at current API mode (see PrlApi_InitEx for more info about API mode). | |
|
Returns the Parallels API version number. | |
|
Initializes Parallels API library. | |
|
Lets to initiate standard Parallels crash dump handler. | |
|
This is extended version of PrlApi_Init call that can be used to specify explicitly application mode in which the API library should function. | |
|
The PrlApi_MsgCanBeIgnored function allows to evaluate an error code and determine if the error is critical (i.e. | |
|
Registers remote devices of specified type | |
|
The PrlApi_ScaleImage scales image and put a new image to a buffer. | |
|
The PrlApi_SendProblemReport lets to send previously extracted with PrlSrv_GetProblemReport or PrlVm_GetProblemReport calls problem report to the Parallels support server. | |
|
| |
|
Sends remote device command to the Virtual Machine. | |
|
Unregisters remote device. | |
|
Obtains the boot device index. | |
|
Obtains the boot device sequence index. | |
|
Returns the boot device type. | |
|
Determines whether the boot device is enabled or disabled. | |
|
Removes the boot device from the boot priority list. | |
|
Sets the boot device index. | |
|
Enables or disables the boot device. | |
|
Assigns a sequence index to a boot device in the boot priority list. | |
|
Sets the boot device type. | |
|
Frees a buffer allocated by the Parallels API library and returned to the client. | |
|
Returns a readable string representation of the specified event type. | |
|
The PrlDbg_GetHandlesNum function determines how many handles were instantiated in the API library. | |
|
Returns a readable string representation of the specified handle type. | |
|
Returns a readable string representation of the PRL_RESULT value. | |
|
Captures a screen area of a remote virtual machine desktop, scales is down to the specified size, and puts it into a buffer. | |
|
Captures a screen area of a remote virtual machine desktop, scales is down to the specified size, and saves it to a file on the client machine. | |
|
Captures a screen area of a remote virtual machine desktop and saves it to a file on the client machine. | |
|
Connects to a virtual machine to begin a remote desktop access session. | |
|
Closes the virtual machine connection that was previously established using the PrlDevDisplay_ConnectToVm function call. | |
|
Determines whether Dynamic Resolution feature is available in the specified virtual machine. | |
|
Returns the contents of the screen buffer of the primary display. | |
|
Returns the primary display screen size of the specified virtual machine. | |
|
Determines if Sliding Mouse feature is enabled in the specified virtual machine. | |
|
Locks the primary screen buffer disallowing any updates to the data it contains. | |
|
The PrlDevDisplay_NeedCursorData function allows to obtain cursor data from the virtual machine. | |
|
Sends a request to capture the specified screen region of the specified virtual machine on a periodic basis. | |
|
Sends a request to a virtual machine to adjust the screen resolution of the guest OS to specified values. | |
|
Sets CoreGraphics surface for fast server-side display updates. | |
|
Captures a screen area of a remote virtual machine desktop, scales is down to the specified size, and puts it into a buffer which is then returned to the client. | |
|
Captures a screen area of a remote virtual machine desktop, scales is down to the specified size, and saves it to a file on the client machine. | |
|
Captures a screen area of a remote virtual machine desktop and saves it to a file on the client machine. | |
|
Unlocks the virtual machine screen buffer that was previously locked with the PrlDevDisplay_LockForRead function call. | |
|
Sends a keyboard key event to a virtual machine. | |
|
Moves a mouse pointer to a relative position and sends a mouse event (presses or releases the specified button). | |
|
Moves a mouse pointer to the specified absolute position within the virtual machine display coordinate grid and sends a mouse event (presses or releases the specified button). | |
|
Captures a screen area of a secondary display of a remote virtual machine, scales is down to the specified size, and puts it into a buffer. | |
|
Captures a screen area of a secondary display of a remote virtual machine, scales is down to the specified size, and saves it to a file on the client machine. | |
|
Returns the contents of the screen buffer of the secondary display. | |
|
Returns the primary display screen size of the specified virtual machine. | |
|
Sends a request to capture the specified screen region of the secondary display of the specified virtual machine on a periodic basis. | |
|
Sends a request to a virtual machine to adjust the screen resolution of the secondary display of the guest OS to specified values. | |
|
Captures a screen area of a secondary display of a remote virtual machine desktop, scales is down to the specified size, and puts it into a buffer which is then returned to the client. | |
|
Captures a screen area of a remote virtual machine desktop, scales is down to the specified size, and saves it to a file on the client machine. | |
|
Determines if new users have the right to modify Parallels Service preferences. | |
|
Returns the backup user login. | |
|
Returns PATH to the default backup directory. | |
|
Returns the default backup server host name or IP address. | |
|
Obtains name and path of the directory in which new virtual machines are created by default. | |
|
Returns the default VNC host name for the Parallels Service. | |
|
Determines the maximum amount of physical memory that can be reserved for Parallels Service operation. | |
|
Determines the maximum memory size that can be allocated to an individual virtual machine. | |
|
Determines the minimum amount of physical memory that must be reserved for Parallels Service operation. | |
|
Determines the lowest allowable security level that can be used to connect to the Parallels Service. | |
|
Determines the minimum required memory size that must be allocated to an individual virtual machine. | |
|
Determines the recommended memory size for an individual virtual machine. | |
|
Determines the amount of physical memory reserved for Parallels Service operation. | |
|
Obtains the currently set base VNC port number. | |
|
Determines whether memory allocation for Parallels Service is performed automatically or manually. | |
|
Returns the backup user password enabling sign. | |
|
Determines whether send statistics reports (CEP) mechanism activated. | |
|
Allows to choose the Parallels Service memory allocation mode from automatic or manual. | |
|
Sets the backup user login. | |
|
Sets the backup user password. | |
|
Sets the backup user password. | |
|
Allows to grant or deny a permission to new users to modify Parallels Service preferences. | |
|
Sets PATH to the default backup directory. | |
|
Sets the default backup server host name or IP address. | |
|
Sets the base VNC host name. | |
|
Allows to manually set the upper limit of the memory size that can be reserved for Parallels Service operation. | |
|
Allows to set the maximum memory size that can be allocated to an individual virtual machine. | |
|
Allows to manually set the lower limit of the memory size that must be reserved for Parallels Service operation. | |
|
Allows to set the lowest allowable security level that can be used to connect to the specified Parallels Service. | |
|
Allows to set the minimum required memory size that must be allocated to an individual virtual machine. | |
|
Allows to manually set recommended memory size for an individual virtual machine. | |
|
Allows to set the amount of memory that will be allocated for Parallels Service operation. | |
|
Allows to switch on/off mechanism of sending statistics reports (CEP). | |
|
Sets the base VNC port number. | |
|
Determines whether the event is critical or not. | |
|
Generates properly formatted and structured answer to a question included in the event. | |
|
Clients can use this method to receive a data buffer specific to the event type. | |
|
Returns the code associated with the event. | |
|
Returns string representation of the event message. | |
|
Returns the event issuer ID (host UUID, virtual machine UUID, etc). | |
|
Returns the event issuer type (virtual machine, host, etc.). | |
|
Obtains the handle of the job that caused the event. | |
|
Obtains a handle of type PHT_EVENT_PARAMETER containing an event parameter data. | |
|
Obtains a handle of type PHT_EVENT_PARAMETER containing an event parameter data by specified parameter name. | |
|
Determines the number of the parameters in the event container. | |
|
Obtains a handle of type PHT_SERVER identifying the Parallels Service that generated the event. | |
|
Returns the type of the event. | |
|
Obtains a handle of type PHT_VIRTUAL_MACHINE referencing the virtual machine that generated the event. | |
|
Determines whether the event requires a response from the client. | |
|
Returns the event parameter value as binary buffer. | |
|
Returns the event parameter name. | |
|
Returns the event parameter data type. | |
|
Returns the event parameter value as boolean (PRL_BOOL). | |
|
Returns the event parameter value as CDATA. | |
|
Returns the event parameter value as PRL_HANDLE. | |
|
Returns the event parameter value as PRL_INT32. | |
|
Returns the event parameter value as PRL_INT64. | |
|
Returns the event parameter value as string. | |
|
Returns the event parameter value as PRL_UINT32. | |
|
Returns the event parameter value as PRL_UINT64. | |
|
Extracts the virtual machine configuration path from the container. | |
|
Extracts the virtual machine name form the container. | |
|
Extracts the virtual machine's OS version from the container. | |
|
Determines if the virtual machine has an old configuration. | |
|
Determines of the specified virtual machine is a template. | |
|
Returns the specified file system entry absolute path. | |
|
Returns the date on which the specified file system entry was last modified. | |
|
Returns the specified file system entry permissions (read, write, execute) for the current user. | |
|
Returns the file system entry relative name. | |
|
Returns the file system entry size. | |
|
Returns the file system entry type (file, directory, drive). | |
|
Determines the number of child entries for the specified remote file system entry. | |
|
Obtains a handle of type PHT_REMOTE_FILESYSTEM_ENTRY containing a child entry information. | |
|
Determines the file system type of the specified file system entry. | |
|
Obtains a handle of type PHT_REMOTE_FILESYSTEM_ENTRY to the parent file system entry. | |
|
Determines the basic type of the specified file system entry. | |
|
Increases the specified handle reference count by one. | |
|
Frees the specified handle. | |
|
Returns the type of the specified handle. | |
|
Adds new handle item to the list. | |
|
Returns handles list item value. | |
|
Returns handles list items count. | |
|
Removes handle item from the list. | |
|
Cancel the specified job. | |
|
The PrlJob_GetDataPtr function is used to obtain a pointer to a buffer containing the results of an asynchronous operation. | |
|
Provides additional job error information. | |
|
Returns the job operation code. | |
|
Obtains a job progress report. | |
|
Obtains a handle of type PHT_RESULT containing the result returned by the job. | |
|
Obtains the return code from the specified job object. | |
|
Obtains the current status of the specified job. | |
|
Returns the sign whether request was sent to remote side or was aborted by some local reasons (wrong params passed or something else). | |
|
The PrlJob_Wait function allows to use asynchronous functions synchronously. | |
|
Returns the name of the company to which this license was issued. | |
|
Returns the license key string. | |
|
Returns the license status. | |
|
Returns the license user name. | |
|
Determines if the license is valid. | |
|
Returns the host OS version. | |
|
Returns the Parallels product version number. | |
|
Obtains a handle of type PHT_RUNNING_TASK. | |
|
Returns the total number of PHT_RUNNING_TASK handles contained in the PHT_LOGIN_RESPONSE object. | |
|
Returns the host machine UUID. | |
|
Returns session UUID string (used to restore a session). | |
|
Returns the Parallels Service network status information. | |
|
Adds a new item to the container. | |
|
Extracts the specified item from the container. | |
|
Determines the number of items in the container. | |
|
Extracts the size of type of items storing in container. | |
|
Removes the specified item from the container. | |
|
Creates a new handle of type PHT_PORT_FORWARDING. | |
|
Returns the incoming port. | |
|
Returns the redirect IP address of the specified port forward entry. | |
|
Returns the redirect port. | |
|
Sets the specified incoming port. | |
|
Sets the specified port forwardi entry redirect IP address. | |
|
Sets the specified redirect port. | |
|
Obtains a handle to an object containing the results of the corresponding asynchronous operation. | |
|
Obtains a string result from the result object. | |
|
Obtains a handle from the result object identified by the index. | |
|
Obtains a string result from the result object identified by the index. | |
|
Determines the number of items in the specified result object. | |
|
Returns task parameters as a string. | |
|
Determines the task type. | |
|
Returns the task UUID (universally unique ID). | |
|
Returns screen resolution height currently used in the virtual machine. | |
|
Returns screen resolution width currently used in the virtual machine. | |
|
Determines if the screen resolution is enabled. | |
|
Removes VM screen resolution object from the parent VM resolutions list. | |
|
Sets VM screen resolution enabling sign. | |
|
Sets VM screen resolution height. | |
|
Sets VM screen resolution width. | |
|
Returns the shared folder description. | |
|
Returns the shared folder name (as it appears in the guest OS). | |
|
Returns the shared folder path. | |
|
Determines whether the share is enabled or not. | |
|
Determines if the share is read-only. | |
|
Removes the share from the virtual machine configuration. | |
|
Sets the shared folder description. | |
|
Enables the specified share. | |
|
Sets the share name (as it will appear in the guest OS). | |
|
Sets the shared folder path. | |
|
Makes the specified shared folder read-only. | |
|
Adds a new virtual network. | |
|
The PrlSrv_AttachToLostTask function allows to obtain a handle to a running task after the connection to the Parallels Service was lost. | |
|
Determines if the Parallels Service on the specified host is running and allows to retrieve its connection information. | |
|
The PrlSrv_CommonPrefsBeginEdit function is used in modifying Parallels Service preferences (see PHT_DISP_CONFIG). | |
|
The PrlSrv_CommonPrefsCommit function is used in modifying Parallels Service preferences (see PHT_DISP_CONFIG). | |
|
Configure hardware generic PCI devices. | |
|
Creates a new handle of type PHT_SERVER. | |
|
Obtains a new handle of type PHT_VIRTUAL_MACHINE. | |
|
Backup an existing virtual machine to backup server. | |
|
Deletes an existing virtual network. | |
|
Determines if the current user has sufficient rights to create a file or a directory in the specified location on the host. | |
|
Creates a directory in the specified location on the host. | |
|
Automatically generates a unique name for a new directory. | |
|
Retrieves information about the specified file system entry residing on the specified host computer. | |
|
Returns a list of root directories on the host computer. | |
|
Removes a file system entry from the host computer. | |
|
Renames a file system entry on the host. | |
|
Get backups tree from backup server. | |
|
Returns a handle of type PHT_DISP_CONFIG containing the specified Parallels Service preferences information. | |
|
Returns an object of type PHT_LICENSE containing the Parallels license information. | |
|
Returns an object of type PHT_NET_SERVICE_STATUS containing the Parallels network service status information. | |
|
Allows to receive a problem report from the Parallels Service in the event of a virtual machine operation failure. | |
|
The PrlSrv_GetQuestions function allows to synchronously receive questions from a Parallels Service. | |
|
Obtains a handle of type PHT_SERVER_INFO containing the host computer information. | |
|
Obtains a handle of type PHT_SERVER_CONFIG containing the host configuration information. | |
|
Obtains a handle of type PHT_SYSTEM_STATISTICS containing the host resource usage statistics. | |
|
Obtains a handle of type PHT_USER_INFO containing information about the specified user. | |
|
Obtains a list of handles of type PHT_USER_INFO containing information about all known users. | |
|
Obtains a handle of type PHT_USER_PROFILE containing the profile data of the currently logged in user. | |
|
Obtains a list of handles of type PHT_VIRTUAL_NETWORK containing information about all existing virtual networks. | |
|
Retrieves a list of virtual machines registered with the specified Parallels Service. | |
|
Determines if the connection to the specified Parallels Service is active. | |
|
Determines if the session is noninteractive or interactive. | |
|
Performs a remote login operation using the specified parameters. | |
|
Allows to log in to the local Parallels Service (the Parallels Service running on this host) using the current user credentials. | |
|
Logs off the Parallels Service. | |
|
Searches the network for running Parallels Services and returns a handle of type PHT_SERVER_INFO for every Parallels Service that it finds. | |
|
Restarts the Parallels network service. | |
|
Restores the default settings of the Parallels network service. | |
|
Starts the Parallels network service. | |
|
Stops the Parallels network service. | |
|
Registers an event handler. | |
|
Registers an existing virtual machine with Parallels Service. | |
|
Registers an existing virtual machine with Parallels Service. | |
|
Remove backup of the virtual machine from backup server. | |
|
Restore backup of the virtual machine from backup server. | |
|
Sends an answer to the Parallels Service in response to a question. | |
|
Sets the session in noninteractive or interactive mode. | |
|
Shuts down the Parallels Service. | |
|
Searches for unregistered virtual machines at the specified location(s). | |
|
Allows to subscribe to receive host OS statistics on a periodic basis. | |
|
Allows to subscribe to periodicaly receive perfomance statistics. | |
|
Unregisters the specified event handler (callback function) that was previously registered with the PrlSrv_RegEventHandler function. | |
|
Cancels the Parallels Service statistics subscription that was started using the PrlSrv_SubscribeToHostStatistics function. | |
|
Cancels the Parallels Service perfomace statistics subscription that was started using the PrlSrv_SubscribeToPerfStats function. | |
|
Installs Parallels license on the specified Parallels Service. | |
|
Updates parameters of an existing virtual network. | |
|
Timestamps the beginning of the user profile editing operation. | |
|
Saves (commits) user profile changes to the Parallels Service. | |
|
Determines the number of CPUs on the host machine. | |
|
Determines the hardware virtualization type of the host CPU. | |
|
Determines the CPU mode (32 bit or 64 bit) on the host. | |
|
Determines the model of CPU on the host machine. | |
|
Determines the host machine CPU speed. | |
|
Returns the global default gateway address of the specified host or guest. | |
|
Obtains the list of IP addresses of DNS servers for the specified host. | |
|
Obtains an object of type PHT_HW_GENERIC_DEVICE containing information about a floppy disk drive on the host. | |
|
Determines the number of floppy disk drives on the host. | |
|
Obtains a handle of type PHT_HW_GENERIC_DEVICE containing information about a generic PCI device installed on the host. | |
|
Determines the number of generic PCI devices installed on the host. | |
|
Obtains a handle of type PHT_HW_GENERIC_DEVICE containing information about a generic SCSI device installed on the host. | |
|
Determines the number of generic SCSI devices installed on the host. | |
|
Obtains an object of type PHT_HW_HARD_DISK containing information about a hard disks drive on the host. | |
|
Determines the number of hard disk drives on the host. | |
|
Returns the server hostname. | |
|
Returns the major version number of the host operating system. | |
|
Returns the minor version number of the host operating system. | |
|
Returns the full host operating system information as a single string. | |
|
Returns the sub-minor version number of the host operating system. | |
|
Returns the host operating system type. | |
|
Determines the amount of memory (RAM) available on the host. | |
|
Obtains an object of type PHT_HW_NET_ADAPTER containing information about a network adapter. | |
|
Determines the number of network adapters available on the server. | |
|
Obtains an object of type PHT_HW_GENERIC_DEVICE containing information about an optical disk on the host. | |
|
Determines the number of optical disks on the host. | |
|
Obtains a handle of type PHT_HW_GENERIC_DEVICE containing information about a parallel port on the host. | |
|
Determines the number of parallel ports on the host. | |
|
Obtains a handle of type PHT_HW_GENERIC_DEVICE containing information about a printer installed on the host. | |
|
Determines the number of printers installed on the host. | |
|
Obtains the list of search domains. | |
|
Obtains a handle of type PHT_HW_GENERIC_DEVICE containing information about a serial port on the host. | |
|
Determines the number of serial ports available on the host. | |
|
Obtains a handle of type PHT_HW_GENERIC_DEVICE containing information about a sound mixer device on the host. | |
|
Determines the number of sound mixer devices available on the host. | |
|
Obtains a handle of type PHT_HW_GENERIC_DEVICE containing information about a sound device on the host. | |
|
Determines the number of sound devices available on the host. | |
|
Obtains a pointer of type PHT_HW_GENERIC_DEVICE containing information about a USB device on the host. | |
|
Determines the number of USB devices on the host. | |
|
Determines whether a sound device on the host is enabled or disabled. | |
|
Determines if USB is supported on the host. | |
|
Determines whether VT-d is supported on the host. | |
|
Returns the device state enumerated in PRL_GENERIC_DEVICE_STATE. | |
|
Returns the system device ID. | |
|
Returns the system device name. | |
|
Returns the device type. | |
|
Determines whether the device is connected to the virtual machine. | |
|
Sets the device state enumerated in PRL_GENERIC_DEVICE_STATE. | |
|
Returns the hard disk device id. | |
|
Returns the hard disk device name. | |
|
Returns the size of the hard disk device. | |
|
Returns the index of a hard disk device. | |
|
Obtains a handle of type PHT_HW_HARD_DISK_PARTITION identifying the specified hard disk partition. | |
|
Returns the number of partitions available on a hard drive. | |
|
Returns the index of the specified hard disk partition. | |
|
Returns a hard disk partition name. | |
|
Returns the hard disk partition size. | |
|
Returns a hard disk partition system name. | |
|
Returns a numerical code identifying the type of the specified partition. | |
|
Determines whether a disk partition is active or inactive. | |
|
Determines whether a disk partition is in use, that is, whether it contains a valid file system, being used for swap or by a database, etc. | |
|
Determines whether the specified partition is a logical partition. | |
|
Returns the default gateway address for the specified network adapter. | |
|
Obtains a list of addresses of DNS servers assigned to the specified network adapter. | |
|
Returns the MAC address of the specified network adapter. | |
|
Returns a network adapter type. | |
|
Obtains a list of network addresses (IP address/Subnet mask pairs) assigned to the specified network adapter. | |
|
Obtains a list of search domains assigned to the specified network adapter. | |
|
Returns a network adapter system index. | |
|
Returns the VLAN tag of the specified network adapter. | |
|
Determines whether the adapter network settings are configured through DHCP. | |
|
Determines whether the adapter is enabled or disabled. | |
|
Returns a generic PCI device class. | |
|
Returns the port number at which the Parallels Service is listening for requests. | |
|
Returns the name of the machine hosting the specified Parallels Service. | |
|
Returns the version of the host operating system. | |
|
Returns the Parallels product version number. | |
|
Returns the host machine UUID (universally unique ID). | |
|
Determines the number of handles of type PHT_SYSTEM_STATISTICS_CPU contained in the specified PHT_SYSTEM_STATISTICS object. | |
|
Obtains a handle of type PHT_SYSTEM_STATISTICS_CPU containing the specified CPU statistics. | |
|
Determines the number of handles of type PHT_SYSTEM_STATISTICS_DISK contained in the specified PHT_SYSTEM_STATISTICS object. | |
|
Obtains a handle of type PHT_SYSTEM_STATISTICS_DISK containing the specified disk statistics. | |
|
Returns the Parallels Service uptime in seconds. | |
|
Returns free RAM size in bytes. | |
|
Returns free swap size in bytes. | |
|
Determines the number of objects of type PHT_SYSTEM_STATISTICS_IFACE contained in the specified PHT_SYSTEM_STATISTICS object. | |
|
Obtains a handle of type PHT_SYSTEM_STATISTICS_IFACE containing the specified network interface statistics. | |
|
Returns operating system uptime in seconds. | |
|
Determines the number of handles of type PHT_SYSTEM_STATISTICS_PROCESS contained in the specified PHT_SYSTEM_STATISTICS object. | |
|
Obtains a handle of type PHT_SYSTEM_STATISTICS_PROCESS containing the specified system process statistics. | |
|
Returns total RAM size in bytes. | |
|
Returns total swap size in bytes. | |
|
Returns the size RAM currently in use (in bytes). | |
|
Returns the size of swap space currently in use (in bytes). | |
|
Determines the number of handles of type PHT_SYSTEM_STATISTICS_USER_SESSION contained in the specified PHT_SYSTEM_STATISTICS object. | |
|
Obtains a handle of type PHT_SYSTEM_STATISTICS_USER_SESSION containing the specified user session statistics. | |
|
Returns the CPU usage, in percents. | |
|
Returns the CPU system time, in seconds. | |
|
Returns the CPU total time in seconds. | |
|
Returns the CPU user time in seconds. | |
|
Returns free disk space, in bytes. | |
|
Determines the number of the handles of type PHT_SYSTEM_STATISTICS_DISK_PARTITION contained in the specified PHT_SYSTEM_STATISTICS_DISK object. | |
|
Obtains a handle of type PHT_SYSTEM_STATISTICS_DISK_PARTITION containing the specified disk partition statistics. | |
|
Returns the disk device name. | |
|
Returns the size of the used space on the specified disk, in bytes. | |
|
Returns the size of the free space on the specified disk partition, in bytes. | |
|
Returns disk partition device name. | |
|
Returns the size of the used space on the specified disk partition, in bytes. | |
|
Returns the total number of bytes the network interface has received since the Parallels Service was last started. | |
|
Returns the total number of packets the network interface has received since the Parallels Service was last started. | |
|
Returns the total number of bytes the network interface has sent since the Parallels Service was last started. | |
|
Returns the total number of packets the network interface has sent since the Parallels Service was last started. | |
|
Returns the network interface system name. | |
|
Returns the process command name. | |
|
Returns process CPU usage in percents. | |
|
Returns process system id. | |
|
Returns process owner user name. | |
|
Returns real memory usage size in bytes. | |
|
Returns start time of the process, in seconds (number of seconds since January 1, 1601 (UTC)). | |
|
Returns process state. | |
|
Returns system running time of the process, in seconds. | |
|
Returns total memory usage size in bytes. | |
|
Returns total running time of the process, in seconds. | |
|
Returns user running time of the process, in seconds. | |
|
Returns virtual memory usage size in bytes. | |
|
Returns the host name of the client machine from which the session was initiated. | |
|
Returns the name of the host system service that created the session. | |
|
Returns session duration, in seconds. | |
|
Returns session user name. | |
|
Adds a new string to the container. | |
|
Extracts the specified string from the container. | |
|
Determines the number of strings in the container. | |
|
Removes the specified string from the container. | |
|
Determines if the current user can modify Parallels Service preferences (PHT_DISP_CONFIG). | |
|
Determines if the user is allowed to use the Parallels Service management console utility. | |
|
Returns name and path of the default virtual machine directory for this user. | |
|
Returns name and path of the default virtual machine folder for this Parallels Service. | |
|
Determines if the user is a local administrator account on the host where Parallels Service started. | |
|
Allows to set a default virtual machine folder for the user. | |
|
Sets user default VM dir. | |
|
Determines whether the specified user is allowed to modify Parallels Service preferences. | |
|
Returns name and path of the default virtual machine directory for the specified user. | |
|
Returns the user name. | |
|
Returns the user active session count. | |
|
Returns the user Universally Unique Identifier (UUID). | |
|
Creates a new handle of type PHT_VIRTUAL_NETWORK. | |
|
Returns a numeric index assigned to the network adapter in the specified virtual network. | |
|
Returns the name of the network adapter in the specified virtual network. | |
|
Obtains physical adapter info which bound to the virtual network object. | |
|
Returns the bound card MAC address of the specified virtual network. | |
|
Returns the description of the specified virtual network. | |
|
Returns the DCHP IP address of the specified virtual network. | |
|
Returns the host IP address of the specified virtual network. | |
|
Returns the IP net mask of the specified virtual network. | |
|
Returns the DHCP end IP address of the specified virtual network. | |
|
Returns the DHCP start IP address of the specified virtual network. | |
|
Returns the ID of the specified virtual network. | |
|
Returns the virtual network type. | |
|
Returns the port forward entries list. | |
|
Returns the VLAN tag of the specified virtual network. | |
|
Determines whether the specified virtual network adapter is enabled or disabled. | |
|
Determines whether the specified virtual network DHCP server is enabled or disabled. | |
|
Determines whether the specified virtual network is enabled or disabled. | |
|
Determines whether the specified virtual network NAT server is enabled or disabled. | |
|
Allows to enable or disable a specified virtual network adapter. | |
|
Sets the specified adapter index. | |
|
Sets the specified virtual network adapter name. | |
|
Sets the specified virtual network bound card MAC address. | |
|
Sets the specified virtual network description. | |
|
Sets the specified virtual network DHCP IP address. | |
|
Allows to enable or disable a specified virtual network DHCP server. | |
|
Allows to enable or disable a specified virtual network. | |
|
Sets the specified virtual network host IP address. | |
|
Sets the specified virtual network IP net mask. | |
|
Sets the specified virtual network DHCP end IP address. | |
|
Sets the specified virtual network DHCP start IP address. | |
|
Allows to enable or disable a specified virtual network NAT server. | |
|
Sets the specified virtual network ID. | |
|
Sets the specified virtual network type. | |
|
Sets the port forward entries list. | |
|
Sets the VLAN tag for the specified virtual network. | |
|
Perform attemption to auth user through guest OS security database. | |
|
The PrlVm_BeginEdit function is used in modifying a virtual machine configuration. | |
|
Cancels the running Compressor operation that was started with PrlVm_RunCompressor. | |
|
Clones an existing virtual machine. | |
|
Clones an existing virtual machine. | |
|
The PrlVm_Commit function is used in modifying a virtual machine configuration. | |
|
Creates VM event that bint to current VM. | |
|
Creates a virtual machine snapshot. | |
|
Creates a floppy disk image in the virtual machine home directory for unattended Windows installation. | |
|
Deletes the specified virtual machine from the host. | |
|
Deleted the specified virtual machine snapshot. | |
|
Resets a suspended virtual machine. | |
|
Automatically generates a name for a virtual device which will be unique within a home directory of the specified virtual machine. | |
|
Obtains a handle of type PHT_VM_CONFIGURATION. | |
|
The PrlVm_GetProblemReport function obtains a problem report on abnormal virtual machine termination. | |
|
The PrlVm_GetQuestions function allows to synchronously receive questions from a Parallels Service. | |
|
Retrieves snapshot information for the specified virtual machine. | |
|
Obtains a handle of type PHT_VM_INFO containing the specified virtual machine state and access rights information. | |
|
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. | |
|
Retrieves the virtual machine screen state before it was suspending. | |
|
Obtains a handle of type PHT_VM_TOOLS_INFO containing information about the state of the Parallels Tools package in a virtual machine. | |
|
This method lets to initiate sending notifications about devices states by VM. | |
|
Begin the Parallels Tools installation process. | |
|
Installs a specified utility in a virtual machine. | |
|
Lets to exclusively lock VM for current session. | |
|
Creates a new console session or binds to an existing GUI session in a virtual machine. | |
|
Migrates an existing virtual machine to another host. | |
|
Cancels the migration operation that was started with PrlVm_Migrate or PrlVm_MigrateEx. | |
|
Migrates an existing virtual machine to another host. | |
|
Pauses the specified virtual machine. | |
|
The PrlVm_RefreshConfig function updates the configuration information contained in the specified virtual machine object (handle). | |
|
Creates a new virtual machine and registers it with the Parallels Service. | |
|
Registers an event handler (callback function) with the virtual machine. | |
|
Resets the specified virtual machine. | |
|
Restarts the operating system of the specified virtual machine. | |
|
Restores the registered virtual machine. | |
|
Resumes a virtual machine that was previously suspended with the PrlVm_Suspend call. | |
|
Initiates the Compressor process. | |
|
The PrlVm_SetConfig is reserved and does nothing. | |
|
Start the specified virtual machine. | |
|
Starts the specified virtual machine using the specified mode (see the PRL_VM_START_MODE enumeration). | |
|
Starts a VNC server for the specified virtual machine. | |
|
Stop the specified virtual machine. | |
|
Stops the VNC server that was previously started for a virtual machine. | |
|
Subscribes to receive the specified virtual machine performance statistics on a periodic basis. | |
|
Suspends the specified virtual machine. | |
|
Reverts the specified virtual machine to the specified snapshot. | |
|
Retrieves a list of identifiers from the Tools Information Service database. | |
|
Obtains a handle of type PHT_TIS_RECORD containing a record from the Tools Information Service database. | |
|
Check graceful shutdown tool capabilities. | |
|
Initiates graceful shutdown of the specified virtual machine. | |
|
Lets to unlock previously locked with PrlVm_Lock call VM. | |
|
Unregisters the specified virtual machine from the Parallels Service. | |
|
Unregisters an event handler (callback function) that was previously registered using the PrlVm_RegEventHandler function. | |
|
Cancels the performance statistics subscription that was previously initiated using the PrlVm_SubscribeToGuestStatistics function. | |
|
Cancels the Parallels Service performance statistics subscription that was started using the PrlVm_SubscribeToPerfStats function. | |
|
Updates access level for the specified virtual machine. | |
|
Modifies the specified virtual machine snapshot name and description. | |
|
Validates the specified section of a virtual machine configuration. | |
|
The PrlVmCfg_AddDefaultDevice function automates the task of setting devices in a virtual machine. | |
|
Creates a new handle of type PHT_BOOT_DEVICE and adds it to the specified virtual machine boot device list. | |
|
Creates a new handle of type PHT_SCREEN_RESOLUTION and adds it to the specified virtual machine resolution list. | |
|
Creates a new handle of type PHT_SHARE and adds it to the specified virtual machine list of shares. | |
|
Creates a new virtual device handle of the specified type. | |
|
Obtains a handle of type PHT_ACCESS_RIGHTS. | |
|
Obtains a handles list of all virtual devices in a virtual machine. | |
|
Determines the current dock mode for the specified virtual machine. | |
|
Determines if the specified virtual machine is set to start automatically on Parallels Service startup. | |
|
Returns the time delay used during the virtual machine automatic startup. | |
|
Determines the mode of the automatic shutdown for the specified virtual machine. | |
|
Determines the specified virtual machine background process priority type. | |
|
Obtains a handle of type PHT_BOOT_DEVICE containing information about a specified device from the virtual machine boot device priority list. | |
|
Determines the number of devices in the virtual machine boot device priority list. | |
|
The PrlVmCfg_GetConfigValidity function returns an error code. | |
|
Determines the virtual machine CPU acceleration level. | |
|
Determines the number of CPUs in the virtual machine. | |
|
Determines the specified virtual machine CPU limit. | |
|
Determines the specified virtual machine CPU mode (32 bit or 64 bit). | |
|
Determines the number of CPU units allocated to a virtual machine. | |
|
Returns the virtual machine custom property information. | |
|
Returns the default gateway of the specified virtual machine. | |
|
The PrlVmCfg_GetDefaultHddSize function returns the default hard disk size for to the specified OS type and version. | |
|
The PrlVmCfg_GetDefaultMemSize function returns the default RAM size for to the specified OS type and version. | |
|
The PrlVmCfg_GetDefaultVideoRamSize function returns the default video RAM size for to the specified OS type and version. | |
|
Returns the specified virtual machine description. | |
|
Obtains a handle to a virtual device in a virtual machine according to the specified device type and index. | |
|
Determines the total number of devices of any type installed in the virtual machine. | |
|
Obtains the number of virtual devices of the specified type available in the specified virtual machine. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_DISPLAY containing information about a display device in a virtual machine. | |
|
Determines the number of display devices in a virtual machine. | |
|
Returns the virtual machine dock icon type. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_FLOPPY containing information about the specified floppy disk drive in a virtual machine. | |
|
Determines the number of floppy disk drives in a virtual machine. | |
|
Returns foreground processes priority for the specified virtual machine. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_GENERIC_PCI containing information about a generic PCI device in a virtual machine. | |
|
Determines the number of generic PCI devices in a virtual machine. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_GENERIC_SCSI containing information about a generic SCSI device in a virtual machine. | |
|
Determines the number of generic SCSI devices in a virtual machine. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_HARD_DISK containing the specified virtual hard disk information. | |
|
Determines the number of virtual hard disks in a virtual machine. | |
|
Returns the virtual machine home directory name and path. | |
|
Obtains the hostname of the specified virtual machine. | |
|
Returns the name of the icon file used by the specified virtual machine. | |
|
Determines the specified virtual machine I/O priority. | |
|
Returns the date and time when the specified virtual machine was last modified. | |
|
Returns the name of the user who last modified the specified virtual machine. | |
|
Returns the name of the specified virtual machine. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_NET_ADAPTER containing information about a virtual network adapter in a virtual machine. | |
|
Determines the number of network adapters in a virtual machine. | |
|
Obtains the list of services available in the virtual machine offline management. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_OPTICAL_DISK containing information a virtual optical disk in a virtual machine. | |
|
Determines the number of optical disks in the specified virtual machine. | |
|
Returns the type of the operating system that the specified virtual machine is running. | |
|
Returns the version of the operating system that the specified virtual machine is running. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_PARALLEL_PORT containing information about a virtual parallel port in the specified virtual machine. | |
|
Determines the number of virtual parallel ports in the specified virtual machine. | |
|
Returns the virtual machine memory (RAM) size, in megabytes. | |
|
Returns the specified virtual machine screen resolution. | |
|
Returns the virtual machine screen resolutions count. | |
|
Obtains the list of globally defined search domains that will be assigned to a virtual machine on the guest operating system side. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_SERIAL_PORT containing information about a serial port in a virtual machine. | |
|
Determines the number of serial ports in a virtual machine. | |
|
Returns the hostname of the machine hosting the specified virtual machine. | |
|
Returns the UUID of the machine hosting the specified virtual machine. | |
|
Obtains a handle of type PHT_SHARE containing information about a shared folder. | |
|
Determines the number of shared folders in a virtual machine. | |
|
Returns smart guard snapshot creation interval in seconds. | |
|
Returns smart guard snapshot maximum storing snapshots count. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_SOUND containing information about a sound device in a virtual machine. | |
|
Determines the number of sound devices in a virtual machine. | |
|
Returns the automatic startup login mode for the specified virtual machine. | |
|
Returns the user name used during the specified virtual machine automatic startup. | |
|
Returns the virtual machine system flags. | |
|
Returns time synchronization between guest and host interval in seconds. | |
|
Determines the current undo disks mode for the specified virtual machine. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_USB_DEVICE containing information about a USB device in a virtual machine. | |
|
Determines the number of USB devices in a virtual machine. | |
|
Returns the UUID (universally unique ID) of the specified virtual machine. | |
|
Returns the video memory size of the specified virtual machine. | |
|
Returns the VNC hostname of the specified virtual machine. | |
|
Returns the VNC mode of the specified virtual machine. | |
|
Returns the VNC password for the specified virtual machine. | |
|
Returns the VNC port number for the specified virtual machine. | |
|
Returns the current window mode the specified virtual machine is in. | |
|
Determines whether select boot device should be shown on virtual machine startup. | |
|
Returns sign whether auto capture and release mouse mode is enabled. | |
|
Returns Virtual Machine close app on shutdown sign. | |
|
Returns Virtual Machine CPU VTx support enabling sign. | |
|
Determines if a virtual machine requires a default device of the specified type if it's going to run an operating system of the specified type. | |
|
Gets the APIC using for virtual machine in runtime. | |
|
Determines if disk cache write-back is enabled for the specified virtual machine. | |
|
Determines the guest OS window behavior in coherence mode. | |
|
Determines if host shared folders are mounted automatically in a given virtual machine. | |
|
Determines if guest sharing is enabled (the guest OS disk drives are visible in the host OS). | |
|
Determines if VM virtual disks will be added to Spotlight search subsystem. | |
|
Determines if host sharing is enabled (host shared folders are visible in the guest OS). | |
|
Determines whether host disks shared into guest Windows OS will be maped on drive letters. | |
|
Determines if the specified virtual machine uses a multi-display mode. | |
|
Determines whether the offline management feature is enabled for a virtual machine. | |
|
Determines if a virtual machine OS resolution is in full screen mode. | |
|
Determines if Windows task bar relocation feature is enabled in a virtual machine when it runs in the coherence mode. | |
|
Determines if additional screen resolution support is enabled in a virtual machine. | |
|
Determines whether all host disks will be present at guest OS as shares. | |
|
Returns sign whether clipboard should sharing between guest and host. | |
|
Returns sign whether shared profile is enabled. | |
|
Determines whether host user home dir will be present at guest OS as share. | |
|
Determines if Windows task bar is displayed when the virtual machine runs in coherence mode. | |
|
Returns sign whether smart guard is enabled. | |
|
Returns sign whether smart guard should notify user before snapshot creation. | |
|
Determines if the specified virtual machine object contains a virtual machine or a template configuration information. | |
|
Returns sign whether time synchronization between guest and host is enabled. | |
|
Returns sign whether time synchronization smart mode between guest and host is enabled. | |
|
Determines whether the Parallels Tools AutoUpdate feature is enabled for a virtual machine. | |
|
Determines whether the use default answers mechanism active for the virtual machine. | |
|
Returns sign whether use desktop in shared profile is enabled. | |
|
Returns sign whether use documents in shared profile is enabled. | |
|
Returns sign whether use music in shared profile is enabled. | |
|
Returns sign whether use pictures in shared profile is enabled. | |
|
Returns sign whether user defined shared folders enabled. | |
|
Switches on/off select boot device dialog on virtual machine startup. | |
|
Sets the dock mode for the applications (see PRL_APP_IN_DOCK_MODE for available options). | |
|
Lets to set auto capture and release mouse mode enabling sign. | |
|
Allows to sets the automatic startup option for the specified virtual machine. | |
|
Sets the time delay that will be used during the virtual machine automatic startup. | |
|
Allows to set the automatic shutdown mode for the specified virtual machine. | |
|
Sets virtual machine background processes priority. | |
|
Sets Virtual Machine close app on shutdown sign. | |
|
Sets CPU acceleration level for the specified virtual machine. | |
|
Sets the number of CPUs for the specified virtual machine (the CPUs should be present in the machine). | |
|
Sets limit of CPU usage for the virtual machine in percents. | |
|
Sets CPU mode (32 bit or 64 bit) for the specified virtual machine. | |
|
Sets the number of CPU units that will be allocated to a virtual machine. | |
|
Sets the virtual machine custom property information. | |
|
The PrlVmCfg_SetDefaultConfig function selects a default configuration for a new virtual machine based on the operating system that the virtual machine will be running. | |
|
Sets the specified virtual machine default gateway. | |
|
Sets the virtual machine description. | |
|
Sets the APIC using for virtual machine in runtime. | |
|
Sets the virtual machine disk cache write-back option. | |
|
Sets the virtual machine dock icon type. | |
|
Sets the exclude dock option. | |
|
Sets the virtual machine foreground processes priority. | |
|
Sets the guest OS sharing auto-mount option. | |
|
Enables the guest sharing feature. | |
|
Sets the VM virtual disks added to Spotlight search subsystem sign. | |
|
Sets the specified virtual machine hostname. | |
|
Enables host sharing for the specified virtual machine. | |
|
Sets the virtual machine icon. | |
|
Sets the specified virtual machine I/O priority. | |
|
Enables mapping of shared host disks on drive letters for the specified virtual machine. | |
|
Sets the virtual machine multi-display option. | |
|
Sets the specified virtual machine name. | |
|
Enables or disables the offline management feature for a virtual machine. | |
|
Allows to manually set offline services that will be available in the virtual machine offline management. | |
|
Sets the virtual machine OS resolution in full screen mode option. | |
|
Sets the virtual machine guest OS version. | |
|
Sets the virtual machine memory (RAM) size. | |
|
Allows to enable or disable the Windows task bar relocation feature. | |
|
Sets the additional screen resolution support option in the specified virtual machine | |
|
Allows to manually set the global search domain list that will be assigned to the virtual machine on the guest OS side. | |
|
Enables sharing of all host disks for the specified virtual machine. | |
|
Lets to set clipboard sharing between guest and host enabling sign. | |
|
Lets to set shared profile enabling sign. | |
|
Enables sharing of host user home dir for the specified virtual machine. | |
|
Allows to show or hide the Windows task bar when the virtual machine is running in coherence mode. | |
|
Lets to set smart guard enabling sign. | |
|
Lets to set smart guard snapshot creation interval in seconds. | |
|
Lets to set smart guard imaximum storing snapshots count. | |
|
Lets to set smart guard noification enabling sign. | |
|
Allows to set the automatic startup login mode for the specified virtual machine. | |
|
Allows to set the automatic startup user login and password for the specified virtual machine. | |
|
Sets Virtual Machine system flags. | |
|
Allows to modify a regular virtual machine to become a template, and vise versa. | |
|
Lets to set time synchronization between guest and host enabling sign. | |
|
Lets to set time synchronization between guest and host interval in seconds. | |
|
Lets to set time synchronization smart mode between guest and host enabling sign. | |
|
Enables or disables the Parallels Tools AutoUpdate feature for a virtual machine. | |
|
Sets the undo disks mode for the virtual machine (see PRL_UNDO_DISKS_MODE for available options). | |
|
Enables the use default answers mechanism in a virtual machine. | |
|
Lets to set use desktop in shared profile enabling sign. | |
|
Lets to set use documents in shared profile enabling sign. | |
|
Lets to set use music in shared profile enabling sign. | |
|
Lets to set use pictures in shared profile enabling sign. | |
|
Lets to set user defined shared folders enabling sign. | |
|
Sets the virtual machine UUID (universally unique ID). | |
|
Sets the virtual machine video memory size. | |
|
Sets the virtual machine VNC host name. | |
|
Sets the virtual machine VNC mode. | |
|
Sets the virtual machine VNC password. | |
|
Sets the virtual machine VNC port number. | |
|
Sets the virtual machine window mode. | |
|
The PrlVmDev_Connect function allows to connect virtual devices while the virtual machine is running. | |
|
Creates a new virtual device handle not bound to any virtual machine. | |
|
Physically creates a virtual device image on the host. | |
|
Allows to disconnect a device while the virtual machine is running. | |
|
Returns the description of a specified virtual device. | |
|
Returns the virtual device emulation type. | |
|
Returns the virtual device user friendly name. | |
|
Returns the virtual device interface type (IDE or SCSI). | |
|
Returns virtual device image path. | |
|
Returns an index identifying the virtual device. | |
|
Returns the virtual device output file. | |
|
Returns the virtual device stack index (position at the controller (IDE or SCSI) bus). | |
|
Returns the virtual device system name. | |
|
Returns the type of the specified device. | |
|
Checks if the specified virtual device is connected. | |
|
Determines if the specified device is enabled. | |
|
Determines if the passthrough mode is enabled for the specified mass storage device. | |
|
Determines if the specified virtual device is a remote device. | |
|
Removes the specified virtual device handle from the parent virtual machine list. | |
|
Resize a virtual device image. | |
|
Connects the specified virtual device. | |
|
Automatically generates and assigns a stack index to a virtual device (a corresponding device interface, IDE or SCSI, has to be set in advance). | |
|
Sets the description for a specified virtual device. | |
|
Sets the specified virtual device emulation type. | |
|
Enables the specified virtual device.. | |
|
Sets virtual device user-friendly name. | |
|
Sets the virtual device interface type (IDE or SCSI). | |
|
Sets the virtual device image path. | |
|
Sets an index identifying the virtual device. | |
|
Sets the virtual device output file. | |
|
Enables the passthrough mode for the specified mass storage device (optical ot hard disk). | |
|
Changes the "remote" flag for the specified device. | |
|
Sets the virtual device stack index (position at the IDE or SCSI controller bus). | |
|
Sets virtual device system name. | |
|
Assigns a boot camp partition to the specified virtual hard disk. | |
|
Returns the hard disk size. | |
|
Returns the hard disk type. | |
|
Obtains a handle of type PHT_VIRTUAL_DEV_HD_PARTITION containing information about the specified partition of the virtual hard disk. | |
|
Determines the number of partitions on the virtual hard disk. | |
|
Returns the size of the occupied space on the hard disk. | |
|
Determines if the virtual hard disk is split into multiple files. | |
|
Sets the size of the specified virtual hard disk. | |
|
Sets the type of the specified virtual hard disk. | |
|
Allows to specify whether the hard disk should be split into multiple files or if a single file should be used. | |
|
Returns the system name of the specified disk partition. | |
|
Removes the specified partition handle from the virtual hard disk list. | |
|
Sets system name for the specified disk partition. | |
|
Generates a unique MAC address for a virtual network adapter on a virtual machine. | |
|
Returns the index of the adapter to which the specified virtual adapter is bound. | |
|
Returns the name of the adapter to which the specified virtual adapter is bound. | |
|
Obtains the default gateway assigned to a virtual network adapter in a virtual machine. | |
|
Obtains the list of DNS servers which is assigned to a virtual network adapter on virtual machine startup. | |
|
Returns the MAC address of a virtual network adapter inside a virtual machine. | |
|
Obtains a list of IP addresses in the address/subnet_mask format which is assigned to a virtual network adapter on virtual machine startup. | |
|
Obtains a lists of search domains which are assigned to a virtual network adapter on virtual machine startup. | |
|
Obtains the virtual network ID assigned to a virtual network adapter in a virtual machine. | |
|
Determines if the specified network adapter is configured to automatically apply network settings inside guest. | |
|
Determines if the specified network adapter is configured through DHCP on the guest OS side. | |
|
Allows to specify whether a network adapter in a virtual machine should be automatically configured. | |
|
Sets the index of the adapter to which the specified virtual adapter should be bound. | |
|
Sets the name of the network adapter to which a virtual network adapter inside a virtual machine will bind. | |
|
Allows to specify whether a network adapter in a virtual machine should be configured through DHCP or manually. | |
|
Allows to manually set the default gateway address for a network adapter in a virtual machine. | |
|
Allows to manually assign DNS servers to a network adapter in a virtual machine. | |
|
Allows to manually set MAC address to a network adapter inside a virtual machine. | |
|
Allows to manually set IP addresses/Subnet masks to a network adapter in a virtual machine. | |
|
Allows to manually assign search domains to a network adapter in a virtual machine. | |
|
Allows to set the virtual network ID for a network adapter in a virtual machine. | |
|
Returns the socket mode of a virtual serial port. | |
|
Sets the socket mode for a virtual serial port. | |
|
Returns mixer device string for the specified sound device. | |
|
Returns output device string for the specified sound device. | |
|
Sets mixer device string for the specified sound device. | |
|
Sets output device string for the specified sound device. | |
|
Obtains USB controller autoconnect device option. | |
|
Sets USB controller autoconnect device option. | |
|
Obtains network settings of an operating system running on a virtual machine. | |
|
Closes a session (or unbinds from a pre-existing session) in a virtual machine that was previously opened with the PrlVm_LoginInGuest function. | |
|
Executes a program in a virtual machine. | |
|
Allows to change the password of a guest operating system user. | |
|
Obtains a handle of type PHT_ACCESS_RIGHTS. | |
|
Returns the virtual machine addition state information. | |
|
Returns the virtual machine state information. | |
|
Determines if the specified virtual machine is invalid. | |
|
Determines if the specified virtual machine is waiting for answer on self question. | |
|
Determines whether a VNC server is running for the specified virtual machine. | |
|
Returns the Parallels Tools package state information. | |
|
Returns version information of the Parallels Tools package installed in a given virtual machine. |
Name |
Description |
Converts API version from the library native format to major and minor values. | |
Current Parallels API version. | |
| |
| |
Converts major and minor versions of the API to the format understood by SDK library. |
Copyright (c) 1999-2009 Parallels Software International Inc.
|
What do you think about this topic? Send feedback!
|