PrlSrv_CheckParallelsServerAlive Function

Determines if the Parallels Service on the specified host is running and allows to retrieve its connection information.

Syntax

PRL_RESULT PrlSrv_CheckParallelsServerAlive(
    PRL_UINT32 timeout, 
    PRL_CONST_STR sServerHostname, 
    PRL_BOOL_PTR pbServerIsAlive, 
    PRL_HANDLE_PTR phServerInfo
);

File

PrlApi.h

Parameters

timeout

Timeout in milliseconds specifying how long the function should wait for a response from the Parallels Service.

sServerHostname

The name of the host machine for which to get the Parallels Service status. To get the status for the local Parallels Service, the parameter can be null or empty.

pbServerIsAlive

[out] A pointer to a variable that receives the result. PRL_TRUE indicates that the Parallels Service is running. PRL_FALSE indicates otherwise.

phServerInfo

[out] A pointer to a variable that receives a handle of type PHT_SERVER_INFO containing the Parallels Service connection information. Pass a null pointer if you don't want to receive the Parallels Service connection information.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer (excluding those that can be null) was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PrlApi.h , PHT_SERVER