PrlVm_Unlock Function

Lets to unlock previously locked with PrlVm_Lock call VM.

Syntax

PRL_HANDLE PrlVm_Unlock(
    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

Note that just VM lock owner session can unlock 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 was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_VIRTUAL_MACHINE