PrlSrv_UserProfileBeginEdit Function

Timestamps the beginning of the user profile editing operation.

Syntax

PRL_HANDLE PrlSrv_UserProfileBeginEdit(
    PRL_HANDLE hServer
);

File

PrlApiDisp.h

Parameters

hServer

A handle of type PHT_SERVER identifying the Parallels Service.

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 this function call. The function, together with the PrlSrv_UserProfileCommit function, is used to detect collisions with other clients 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.

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_ACCESS_DENIED - the user does not have sufficient rights to perform this task.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_SERVER