oshi.jna.platform.windows

Interface IPHlpAPI

All Superinterfaces:

com.sun.jna.Library

public interface IPHlpAPI
extends com.sun.jna.Library

Windows IP Helper API. This class should be considered non-API as it may be removed if/when its code is incorporated public into the JNA project.

Author:

widdis[at]gmail[dot]com

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IPHlpAPI.FIXED_INFO
static class	IPHlpAPI.IP_ADDR_STRING
static class	IPHlpAPI.IP_ADDRESS_STRING
static class	IPHlpAPI.MIB_IFROW
static class	IPHlpAPI.MIB_IFROW2

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR_BUFFER_OVERFLOW
static int	IF_MAX_PHYS_ADDRESS_LENGTH
static int	IF_MAX_STRING_SIZE
static IPHlpAPI	INSTANCE
static int	MAX_DOMAIN_NAME_LEN
static int	MAX_HOSTNAME_LEN
static int	MAX_INTERFACE_NAME_LEN
static int	MAX_SCOPE_ID_LEN
static int	MAXLEN_IFDESCR
static int	MAXLEN_PHYSADDR

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method and Description
int	GetIfEntry(IPHlpAPI.MIB_IFROW pIfRow) The GetIfEntry function retrieves information for the specified interface on the local computer.
int	GetIfEntry2(IPHlpAPI.MIB_IFROW2 pIfRow2) The GetIfEntry2 function retrieves information for the specified interface on the local computer.
int	GetNetworkParams(IPHlpAPI.FIXED_INFO pFixedInfo, com.sun.jna.platform.win32.WinDef.ULONGByReference pOutBufLen) The GetNetworkParams function retrieves network parameters for the local computer.

Field Detail

INSTANCE

static final IPHlpAPI INSTANCE

IF_MAX_STRING_SIZE

static final int IF_MAX_STRING_SIZE

See Also:

Constant Field Values

IF_MAX_PHYS_ADDRESS_LENGTH

static final int IF_MAX_PHYS_ADDRESS_LENGTH

See Also:

Constant Field Values

MAX_INTERFACE_NAME_LEN

static final int MAX_INTERFACE_NAME_LEN

See Also:

Constant Field Values

MAXLEN_IFDESCR

static final int MAXLEN_IFDESCR

See Also:

Constant Field Values

MAXLEN_PHYSADDR

static final int MAXLEN_PHYSADDR

See Also:

Constant Field Values

MAX_HOSTNAME_LEN

static final int MAX_HOSTNAME_LEN

See Also:

Constant Field Values

MAX_DOMAIN_NAME_LEN

static final int MAX_DOMAIN_NAME_LEN

See Also:

Constant Field Values

MAX_SCOPE_ID_LEN

static final int MAX_SCOPE_ID_LEN

See Also:

Constant Field Values

ERROR_BUFFER_OVERFLOW

static final int ERROR_BUFFER_OVERFLOW

See Also:

Constant Field Values

Method Detail

GetIfEntry

int GetIfEntry(IPHlpAPI.MIB_IFROW pIfRow)

The GetIfEntry function retrieves information for the specified interface on the local computer. The dwIndex member in the MIB_IFROW structure pointed to by the pIfRow parameter must be initialized to a valid network interface index retrieved by a previous call to the GetIfTable, GetIfTable2, or GetIfTable2Ex function. The GetIfEntry function will fail if the dwIndex member of the MIB_IFROW pointed to by the pIfRow parameter does not match an existing interface index on the local computer.

Parameters:

pIfRow - A pointer to a MIB_IFROW structure that, on successful return, receives information for an interface on the local computer. On input, set the dwIndex member of MIB_IFROW to the index of the interface for which to retrieve information.

Returns:

If the function succeeds, the return value is NO_ERROR.

GetIfEntry2

int GetIfEntry2(IPHlpAPI.MIB_IFROW2 pIfRow2)

The GetIfEntry2 function retrieves information for the specified interface on the local computer. On input, at least one of the following members in the MIB_IF_ROW2 structure passed in the Row parameter must be initialized: InterfaceLuid or InterfaceIndex. The fields are used in the order listed above. So if the InterfaceLuid is specified, then this member is used to determine the interface. If no value was set for the InterfaceLuid member (the value of this member was set to zero), then the InterfaceIndex member is next used to determine the interface. On output, the remaining fields of the MIB_IF_ROW2 structure pointed to by the Row parameter are filled in.

Parameters:

pIfRow2 - A pointer to a MIB_IF_ROW2 structure that, on successful return, receives information for an interface on the local computer. On input, the InterfaceLuid or the InterfaceIndex member of the MIB_IF_ROW2 must be set to the interface for which to retrieve information.

Returns:

If the function succeeds, the return value is NO_ERROR.

GetNetworkParams

int GetNetworkParams(IPHlpAPI.FIXED_INFO pFixedInfo,
                     com.sun.jna.platform.win32.WinDef.ULONGByReference pOutBufLen)

The GetNetworkParams function retrieves network parameters for the local computer.

Parameters:

pFixedInfo - A pointer to a buffer that contains a FIXED_INFO structure that receives the network parameters for the local computer, if the function was successful. This buffer must be allocated by the caller prior to calling the GetNetworkParams function.

pOutBufLen - A pointer to a ULONG variable that specifies the size of the FIXED_INFO structure. If this size is insufficient to hold the information, GetNetworkParams fills in this variable with the required size, and returns an error code of ERROR_BUFFER_OVERFLOW.

Returns:

If the function succeeds, the return value is ERROR_SUCCESS.