PrlSrv_UserProfileCommit Function

Saves (commits) user profile changes to the Parallels Service.

Syntax

PRL_HANDLE PrlSrv_UserProfileCommit(
    PRL_HANDLE hServer, 
    PRL_HANDLE hUserProfile
);

File

PrlApi.h

Parameters

hServer

A handle of type PHT_SERVER identifying the Parallels Service.

hUserProfile

A handle of type PHT_USER_PROFILE containing the user information.

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

Every modification to the user profile (see PHT_USER_PROFILE ) must begin with the PrlSrv_UserProfileBeginEdit function call. The function, together with the PrlSrv_UserProfileCommit function, is used to detect collisions with other client trying to modify the profile of the same user at the same time. The function does not lock the profile being edited. If a collision is detected on commit, the changes are rejected. Otherwise, the changes are saved to the Parallels Service.

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

PrlApi.h , PHT_SERVER