PrlSrvCfg_GetNetAdapter Function

Obtains a handle of type PHT_HW_NET_ADAPTER containing information about a network adapter installed in the host or guest.

Syntax

PRL_RESULT PrlSrvCfg_GetNetAdapter(
    PRL_HANDLE hSrvConfig, 
    PRL_UINT32 nIndex, 
    PRL_HANDLE_PTR phDevice
);

File

PrlApiDisp.h

Parameters

hSrvConfig

A handle of type PHT_SERVER_CONFIG. When obtaining the host OS information, use the PrlSrv_GetSrvConfig to obtain the handle. When obtaining the guest OS information, use the PrlVmGuest_GetNetworkSettings function.

nIndex

A numeric index identifying the network adapter (beginning with 0). To get the number of adapters available, use the PrlSrvCfg_GetNetAdaptersCount function.

phDevice

[out] A pointer to a variable that receives a handle of type PHT_HW_NET_ADAPTER containing the network adapter information.

Returns

PRL_RESULT. Possible values:

PRL_ERR_INVALID_ARG - invalid handle or null pointer was passed.

PRL_ERR_SUCCESS - function completed successfully.

Links

PHT_SERVER_CONFIG