PrlVm_InstallUtility Function

Installs a specified utility in a virtual machine.

Syntax

PRL_HANDLE PrlVm_InstallUtility(
    PRL_HANDLE hVm, 
    PRL_CONST_STR strId
);

File

PrlApi.h

Parameters

strId

A string identifying the utility to install.

hServer

A handle of type PHT_VIRTUAL_MACHINE identifying the Parallels Service.

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

This functions is a part of the Parallels Tools functionality.

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

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PrlApi.h, PHT_VIRTUAL_MACHINE