PrlSrv_GetVirtualNetworkList Function

Obtains a list of handles of type PHT_VIRTUAL_NETWORK containing information about all existing virtual networks.

Syntax

PRL_HANDLE PrlSrv_GetVirtualNetworkList(
    PRL_HANDLE hServer, 
    PRL_UINT32 nFlags
);

File

PrlApiNet.h

Parameters

hServer

A handle of type PHT_SERVER identifying the Parallels Service.

nFlags

Reserved parameter.

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 or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

To get the results from the PHT_JOB object:

Use the PrlJob_GetResult function to obtain a handle to the PHT_RESULT object.

Use the PrlResult_GetParamByIndex function to obtain a handle of type PHT_VIRTUAL_NETWORK containing the information about a virtual network.

Links

PHT_SERVER