PrlSrv_CommonPrefsCommit Function

The PrlSrv_CommonPrefsCommit function is used in modifying Parallels Service preferences (see PHT_DISP_CONFIG).

Syntax

PRL_HANDLE PrlSrv_CommonPrefsCommit(
    PRL_HANDLE hServer, 
    PRL_HANDLE hDispCfg
);

File

PrlApiDisp.h

Parameters

hServer

A handle of type PHT_SERVER identifying the Parallels Service.

hDispCfg

A handle of type PHT_DISP_CONFIG containing the Parallels Service preferences.

nFlags

Reserved flags

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

The PrlSrv_CommonPrefsBeginEdit and the PrlSrv_CommonPrefsCommit functions are used to detect collisions with other clients trying to modify preferences of the same Parallels Service. The PrlSrv_CommonPrefsBeginEdit call timestamps the beginning of the operation. It does not lock the Parallels Service, so other clients can modify the same Parallels Service at the same time. When you are done making the changes, you must call the PrlSrv_CommonPrefsCommit function to apply them to the Parallels Service. The function will verify that the Parallels Service preferences have not been modified by another client. If a collision is detected, your changes will be 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_SUCCESS - function completed successfully.

Links

PHT_SERVER