PrlVm_AuthWithGuestSecurityDb Function

Perform attemption to auth user through guest OS security database.

Syntax

PRL_HANDLE PrlVm_AuthWithGuestSecurityDb(
    PRL_HANDLE hVm, 
    PRL_CONST_STR sUserName, 
    PRL_CONST_STR sUserPassword, 
    PRL_UINT32 nFlags
);

File

PrlApi.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

sUserName

string that should contain valid guest user login

sUserPassword

string that should contain user password (can be empty or null in case when user account do not has password)

nFlags

a bitset of flags (should be 0 in current implementation)

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 or null pointer (empty string) for user name was passed. PRL_ERR_AUTHENTICATION_FAILED - failed to authorize user PRL_ERR_SUCCESS - authorization successfully completed.

Links

PrlApi.h, PHT_VIRTUAL_MACHINE