Collapse All
Parallels Virtualization SDK
ContentsIndex
PreviousUpNext
PrlSrv_GetNetServiceStatus Function
PHT_SERVER  Example

Returns an object of type PHT_NET_SERVICE_STATUS containing the Parallels network service status information.

Syntax
PRL_HANDLE PrlSrv_GetNetServiceStatus(
    PRL_HANDLE hServer
);
File

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

 

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. 

To get the result from the PHT_JOB object:

  1. Use the PrlJob_GetResult function to obtain a handle to the PHT_RESULT object.
  2. Use the PrlResult_GetParam function to obtain a handle of type PHT_NET_SERVICE_STATUS containing the NET service status.
Example

The following example illustrates how to obtain a handle of type PHT_NET_SERVICE_STATUS containing the Parallels Service network service status.

hJob =
PrlSrv_GetNetServiceStatus( hServer );
PrlJob_Wait( hJob, 10000 );
PrlJob_GetResult( hJob, &hJobResult );
PrlHandle_Free( hJob );

// Get the PHT_NET_SERVICE_STATUS handle.
PRL_HANDLE hHandle;
PrlResult_GetParam( hJobResult, &hHandle );
Links
© 2021 Parallels International GmbH. All rights reserved.