PrlVm_Move Function

Move bundle of virtual machine or private area of container.

Syntax

PRL_HANDLE PrlVm_Move(
    PRL_HANDLE hVm, 
    PRL_CONST_STR sNewHomePath, 
    PRL_UINT32 nFlags
);

File

PrlApiVm.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine or container.

sNewHomePath

Target path for Vm bundle

nFlags

Flags that specify move type. Not used yet.

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

The function move all content of bundle to specify location. This function will move only stopped or suspended Vm.

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