PrlVm_Unreg Function

Unregisters the specified virtual machine from the Parallels Service.

Syntax

PRL_HANDLE PrlVm_Unreg(
    PRL_HANDLE hVm
);

File

PrlApiVm.h

Parameters

handle

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

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 call removes the virtual machine from the Parallels Service registry, but does not delete the virtual machine files from the hard drive. You can re-register a machine with the Parallels Service at any time using the PrlSrv_RegisterVm or PrlSrv_RegisterVmEx functions call.

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

PHT_VIRTUAL_MACHINE