PrlSrv_Logoff Function

Logs off the Parallels Service.

Syntax

PRL_HANDLE PrlSrv_Logoff(
    PRL_HANDLE hServer
);

File

PrlApi.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

The function logs of the Parallels Service and ends a session that was started with the PrlSrv_Login or the PrlSrv_LoginLocal function.

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