PrlSrv_InstallAppliance Function

Sends an appliance configuration to the Parallels Service in order to install the corresponding appliance from Parallels download service.

Syntax

PRL_HANDLE PrlSrv_InstallAppliance(
    PRL_HANDLE hServer, 
    PRL_HANDLE hAppCfg, 
    PRL_CONST_STR sVmParentPath, 
    PRL_UINT32 nFlags
);

File

PrlApi.h

Parameters

hServer

A handle of type PHT_SERVER identifying the Parallels Service.

hAppCfg

A handle of type PHT_APPLIANCE_CONFIG identifying the appliance.

sVmParentPath

Optional. Name and path of the parent directory where the virtual machine appliance should be installed. If this parameter is omitted (null pointer or empty string is passed), the new virtual machine appliance directory will be created in the default directory for this Parallels Service.

nFlags

Reserved parameter

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation or PRL_INVALID_HANDLE if there's not enough memory to instantiate the job object.

Remarks

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are:

PRL_ERR_INVALID_ARG - invalid handle was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PrlApi.h , PHT_SERVER