PrlDispCfg_GetDispNet Function

Obtains information about a virtual network adapter from the Parallels Service configuration.

Syntax

PRL_RESULT PrlDispCfg_GetDispNet(
    PRL_HANDLE hDispCfg, 
    PRL_UINT32 nDispNetIndex, 
    PRL_HANDLE_PTR phDispNet
);

File

PrlApi.h

Parameters

hDispCfg

A handle of type PHT_DISP_CONFIG .

nDispNetIndex

An index identifying the adapter in the adapter list starting with 0 and up. To obtain the total number of the available adapters, use the PrlDispCfg_GetDispNetCount function.

phDispNet

[out] A pointer to a handle of type PHT_DISP_NET_ADAPTER . On function return, the object will contain the specified net adapter information.

Returns

PRL_RESULT . Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Remarks

Parallels Service can have multiple network adapters, each identified by a numeric index starting with 0 and up. Use PrlDispCfg_GetDispNetCount to determine the total adapter count and then obtain each adapter information by calling this function in a loop, passing an index counter in each iteration.

Links

PrlApi.h , PHT_DISP_CONFIG