PrlVmGuest_SetUserPasswd Function

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

Syntax

PRL_HANDLE PrlVmGuest_SetUserPasswd(
    PRL_HANDLE hVmGuest, 
    PRL_CONST_STR sUserName, 
    PRL_CONST_STR sUserPasswd, 
    PRL_UINT32 nFlags
);

File

PrlApiVm.h

Parameters

hVmGuest

A handle of type PHT_VM_GUEST_SESSION identifying the user session in a virtual machine. The handle is obtained using the PrlVm_LoginInGuest function.

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

Prior to calling this function, a handle to a user session in a virtual machine must be obtained using the PrlVm_LoginInGuest function.

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.