PrlSrv_RegisterVmWithParams Function

Registers an existing virtual machine with specified params.

Syntax

PRL_HANDLE PrlSrv_RegisterVmWithParams(
    PRL_HANDLE hServer, 
    PRL_HANDLE hParams
);

File

PrlApiVm.h

Parameters

hServer

A handle of type PHT_SERVER identifying the Parallels Service.

hParams

A handle of type PHT_VM_REGISTER_PARAMS identifying the registration params.

Returns

A handle of type PHT_JOB containing the results of this asynchronous operation, including the return code and a handle of type PHT_VIRTUAL_MACHINE containing information about the virtual machine that was registered.

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.

To get the results from the PHT_JOB object:

Use the PrlJob_GetResult function to obtain a handle to

the PHT_RESULT object.

Use the PrlResult_GetParam function to obtain a handle

of type PHT_VIRTUAL_MACHINE.

Links

PHT_SERVER