PrlVm_AuthWithGuestSecurityDb Function

Performs an attempt to authenticate the user through the guest OS security database.

Syntax

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

File

PrlApiVm.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

sUserName

User login name.

sUserPassword

User password (can be an empty string or NULL if the user doesn't have a password).

nFlags

A bitset of flags (should be 0 in the 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 - user authentication failed.

PRL_ERR_SUCCESS - user authenticated successfully.

Links

PHT_VIRTUAL_MACHINE