PrlSrv_GetUserInfo Function

Obtains a handle of type PHT_USER_INFO containing information about the specified user.

Syntax

PRL_HANDLE PrlSrv_GetUserInfo(
    PRL_HANDLE hServer, 
    PRL_CONST_STR sUserId
);

File

PrlApi.h

Parameters

hServer

A handle of type PHT_SERVER identifying the Parallels Service.

sUserId

UUID of the user to obtain the information for.

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 was passed.

PRL_ERR_SUCCESS - function completed successfully.

To get the results from the PHT_JOB object:

Use the PrlJob_GetResult function to obtain a handle to the PHT_RESULT object.

Use the PrlResult_GetParam function to obtain a handle of type PHT_USER_INFO containing the user information.