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

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 IPHlpAPI	INSTANCE
static int	MAX_INTERFACE_NAME_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

Field Detail

INSTANCE

static final IPHlpAPI INSTANCE

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

Method Detail

GetIfEntry

int GetIfEntry(IPHlpAPI.MIB_IFROW pIfRow)

The GetIfEntry function retrieves information for the specified interface 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.