PrlSrv_GetServerInfo Function

Obtains a handle of type PHT_SERVER_INFO containing the host computer information.

Syntax

PRL_RESULT PrlSrv_GetServerInfo(
    PRL_HANDLE hServer, 
    PRL_HANDLE_PTR phServerInfo
);

File

PrlApiDisp.h

Parameters

hServer

A handle of type PHT_SERVER identifying the Parallels Service.

phServerInfo

[out] A pointer to a variable that receives a handle to the server info object.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Please note that in order to obtain the complete host info, the function must be called after the login operation is completed and the results of the login operation are received. In all other situations, some of the Parallels Service properties may not be populated.

Links

PHT_SERVER