PrlVm_Encrypt Function

Encrypts virtual machine data using specified secret password phrase.

Syntax

PRL_HANDLE PrlVm_Encrypt(
    PRL_HANDLE hVm, 
    PRL_CONST_STR sPassword, 
    PRL_CONST_STR sCipherPluginUuid, 
    PRL_UINT32 nFlags
);

File

PrlApi.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine object.

sPassword

Password to encrypt virtual machine. UTF-8 encoded string ending with null (0) symbol. Can be null (0) in case of empty password.

sCipherPluginUuid

Parameter reserved for further purposes - currently 0 should be specified.

nFlags

Bitset of flags - flags from enums PRL_ENCRYPTION_FLAGS and PRL_API_COMMAND_FLAGS

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_MACHINE type) was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PrlApi.h , PHT_VIRTUAL_MACHINE