PrlVmDevHd_CheckPassword Function

Checks whether specified for encrypted virtual hard disk password matched to the current one.

Syntax

PRL_HANDLE PrlVmDevHd_CheckPassword(
    PRL_HANDLE hVmDev, 
    PRL_UINT32 nFlags
);

File

PrlApiVm.h

Parameters

hVmDev

A handle of type PHT_VIRTUAL_DEV_HARD_DISK identifying the virtual hard disk object.

nFlags

Bitset of flags - reserved parameter for further purposes.

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

To get the return code from the PHT_JOB object, use the PrlJob_GetRetCode function. Possible values are:

PRL_ERR_INVALID_ARG - can be returned in follow cases: invalid handle (NULL or not of PHT_VIRTUAL_DEV_HARD_DISK type) was passed; virtual hard disk device object isn't bound to any VM object (was created with PrlVmDev_Create call for example); PrlVmDevHd_SetPassword wasn't called before this call - nothing to check then.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_VIRTUAL_DEV_HARD_DISK