Collapse All
Parallels Desktop® 10 for Mac — C API Reference Guide
System Functions
Functions Common Functions Legend Topics

Common Parallels API system functions.

Functions
Name
Description
Calculates hash for specified icon data which can be used later in PrlApi_ValidateInCache .
Create credentials (certificate signing request / private key) for user.
Creates a new handle of type PRL_HANDLES_LIST.
Creates a new handle of type PHT_OPAQUE_TYPE_LIST .
Creates and returns a handle of type PHT_PROBLEM_REPORT , which is used to obtain and manage Parallels problem reports.
Creates a new handle of type PHT_STRINGS_LIST .
De-initializes the library.
Returns the Parallels API application mode.
Returns the name and path of the directory where Parallels crash dumps are stored.
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).
Allows to get arbitrary data from the cloud user storage.
Allows to get arbitrary data keys from the cloud user storage.
Returns the Parallels API version number.
Initializes Parallels API library.
Initiates the 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.
Allows to put arbitrary icon to the cloud user storage.
Allows to put arbitrary data to the cloud user storage.
Registers remote devices of specified type
Allows to remove arbitrary data from the cloud user storage.
The PrlApi_ScaleImage scales image and put a new image to a buffer.
The PrlApi_SendPackedProblemReport lets to send previously extracted with PrlSrv_GetPackedProblemReport or PrlVm_GetPackedProblemReport calls problem report to the Parallels support server.
The PrlApi_SendProblemReport lets to send previously extracted with PrlSrv_GetProblemReport or PrlVm_GetProblemReport calls problem report to the Parallels support server.
Sign user certificate on manager CA .
Sign user certificate on manager CA.
Allows to sign for postponed notification about desired host registration on Manager.
Turn on/off print logging messages on console
PRL_ERR_SUCCESS - function completed successfully.
Unregisters remote device.
Allows to check whether the specified icon hashes are present in the cache.
Creates a new handle of type PHT_APPLIANCE_CONFIG.
Topics
Links
Copyright © 1999-2015 Parallels IP Holdings GmbH and its affiliates. All rights reserved.
What do you think about this topic? Send feedback!