PrlVm_SetUserPasswd Function

Allows to change the password of a guest operating system user.

Syntax

PRL_HANDLE PrlVm_SetUserPasswd(
    PRL_HANDLE hVm, 
    PRL_CONST_STR sUserName, 
    PRL_CONST_STR sUserPasswd, 
    PRL_UINT32 nFlags
);

File

PrlApiVm.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

sUserName

Guest operating system user name. Can be null or empty string when setting the administrator password.

sUserPasswd

New password. Can be null when setting an empty password.

nFlags

Bitset of flags - from enum PRL_SET_USERPASSWD_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 - invalid handle was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_VIRTUAL_MACHINE