Collapse All
Parallels C API Reference Guide
PHT_SERVER
Functions Functions by Handle Legend Send Feedback

At the root of the Parallels API class hierarchy is a handle of type PHT_SERVER. The handle can be obtained using the PrlSrv_Create function. The PHT_SERVER handle is required to use most of the functionality within the Parallels API.

Functions
Name
Description
Adds a new virtual network adapter to the specified Parallels Service.
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 ).
Creates a new handle of type PHT_SERVER.
Obtains a new handle of type PHT_VIRTUAL_MACHINE .
Removes a virtual network adapter from the Parallels Service configuration.
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.
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.
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.
Sends an answer to the Parallels Service in response to a question.
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.
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 an existing virtual network adapter in the specified Parallels Service.
Timestamps the beginning of the user profile editing operation.
Saves (commits) user profile changes to the Parallels Service.
Links
Copyright (c) 1999-2008 Parallels Software International Inc.
What do you think about this topic? Send feedback!