PrlVm_Lock Function

Lets to exclusively lock VM for current session.

Syntax

PRL_HANDLE PrlVm_Lock(
    PRL_HANDLE hVm, 
    PRL_UINT32 nReserved
);

File

PrlApiVm.h

Parameters

nReserved

reserved param for further purposes

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

After this call just current sesiion be able to operate with locked VM until PrlVm_Unlock will be called or current session will be closed. If VM was already locked by some another session (or the same one) then lock operation will fail.

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

PHT_VIRTUAL_MACHINE