Top Description Inners Fields Methods

com.sun.jna.platform.win32

public Interface IPHlpAPI

Imports: com.sun.jna.Library, .Native, .Pointer, .Structure, .Structure.FieldOrder, com.sun.jna.platform.win32.Guid.GUID, com.sun.jna.ptr.IntByReference, com.sun.jna.win32.W32APIOptions

Windows IP Helper API

See Also: IP Helper Reference

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	IPHlpAPI.FIXED_INFO The FIXED_INFO structure contains information that is the same across all the interfaces on a computer.
public static class	IPHlpAPI.IP_ADDR_STRING The IP_ADDR_STRING structure represents a node in a linked-list of IPv4 addresses.
public static class	IPHlpAPI.IP_ADDRESS_STRING The IP_ADDRESS_STRING structure stores an IPv4 address in dotted decimal notation.
public static class	IPHlpAPI.MIB_IF_ROW2 The MIB_IF_ROW2 structure stores information about a particular interface.
public static class	IPHlpAPI.MIB_IFROW The MIB_IFROW structure stores information about a particular interface.
public static class	IPHlpAPI.MIB_TCP6ROW_OWNER_PID Contains information that describes an IPv6 TCP connection.
public static class	IPHlpAPI.MIB_TCP6TABLE_OWNER_PID Contains a table of IPv6 TCP connections on the local computer.
public static interface	IPHlpAPI.MIB_TCP_STATE Enumerates different possible TCP states.
public static class	IPHlpAPI.MIB_TCPROW_OWNER_PID Contains information that describes an IPv4 TCP connection.
public static class	IPHlpAPI.MIB_TCPSTATS The MIB_TCPSTATS structure contains statistics for the TCP protocol running on the local computer.
public static class	IPHlpAPI.MIB_TCPTABLE_OWNER_PID Contains a table of IPv4 TCP connections on the local computer.
public static class	IPHlpAPI.MIB_UDP6ROW_OWNER_PID Contains information that describes an IPv6 UDP connection.
public static class	IPHlpAPI.MIB_UDP6TABLE_OWNER_PID Contains a table of IPv6 UDP connections on the local computer.
public static class	IPHlpAPI.MIB_UDPROW_OWNER_PID Contains information that describes an IPv6 UDP connection.
public static class	IPHlpAPI.MIB_UDPSTATS The MIB_UDPSTATS structure contains statistics for the User Datagram Protocol (UDP) running on the local computer.
public static class	IPHlpAPI.MIB_UDPTABLE_OWNER_PID Contains a table of IPv6 UDP connections on the local computer.
public static interface	IPHlpAPI.TCP_TABLE_CLASS Defines the set of values used to indicate the type of table returned by calls to `GetExtendedTcpTable`
public static interface	IPHlpAPI.UDP_TABLE_CLASS Defines the set of values used to indicate the type of table returned by calls to `GetExtendedUdpTable`.

Field Summary

Modifier and Type	Field and Description
public static final int	AF_BTH
public static final int	AF_INET
public static final int	AF_INET6
public static final int	AF_IPX
public static final int	AF_IRDA
public static final int	AF_NETBIOS
public static final int	AF_UNSPEC
public static final int	IF_MAX_PHYS_ADDRESS_LENGTH
public static final int	IF_MAX_STRING_SIZE
public static final IPHlpAPI	INSTANCE
public static final int	MAX_DOMAIN_NAME_LEN
public static final int	MAX_HOSTNAME_LEN
public static final int	MAX_INTERFACE_NAME_LEN
public static final int	MAX_SCOPE_ID_LEN
public static final int	MAXLEN_IFDESCR
public static final int	MAXLEN_PHYSADDR

Inherited from 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_SYMBOL_PROVIDER OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method and Description
public int	Returns: If the function succeeds, the return value is `NO_ERROR`. If the function fails, the return value is an error code. GetExtendedTcpTable(Pointer A pointer to the table structure that contains the filtered TCP endpoints available to the application. pTcpTable, IntByReference The estimated size of the structure returned in pTcpTable, in bytes. If this value is set too small, `ERROR_INSUFFICIENT_BUFFER` is returned by this function, and this field will contain the correct size of the structure. pdwSize, boolean A value that specifies whether the TCP connection table should be sorted. If this parameter is set to TRUE, the TCP endpoints in the table are sorted in ascending order, starting with the lowest local IP address. If this parameter is set to FALSE, the TCP endpoints in the table appear in the order in which they were retrieved. The following values are compared (as listed) when ordering the TCP endpoints: Local IP address, Local scope ID (applicable when the ulAf parameter is set to AF_INET6), Local TCP port, Remote IP address, Remote scope ID (applicable when the ulAf parameter is set to AF_INET6), Remote TCP port. bOrder, int The version of IP used by the TCP endpoints. ulAf, int The type of the TCP table structure to retrieve. This parameter can be one of the values from the `TCP_TABLE_CLASS` enumeration. TableClass, int Reserved. This value must be zero. Reserved) Retrieves a table that contains a list of TCP endpoints available to the application.
public int	Returns: If the function succeeds, the return value is `NO_ERROR`. If the function fails, the return value is an error code. GetExtendedUdpTable(Pointer A pointer to the table structure that contains the filtered UDP endpoints available to the application. pUdpTable, IntByReference The estimated size of the structure returned in pTcpTable, in bytes. If this value is set too small, `ERROR_INSUFFICIENT_BUFFER` is returned by this function, and this field will contain the correct size of the structure. pdwSize, boolean A value that specifies whether the TCP connection table should be sorted. If this parameter is set to TRUE, the TCP endpoints in the table are sorted in ascending order, starting with the lowest local IP address. If this parameter is set to FALSE, the TCP endpoints in the table appear in the order in which they were retrieved. The following values are compared (as listed) when ordering the TCP endpoints: Local IP address, Local scope ID (applicable when the ulAf parameter is set to `AF_INET6`), Local TCP port, Remote IP address, Remote scope ID (applicable when the ulAf parameter is set to `AF_INET6`), Remote TCP port. bOrder, int The version of IP used by the UDP endpoints. ulAf, int The type of the TCP table structure to retrieve. This parameter can be one of the values from the `TCP_TABLE_CLASS` enumeration. TableClass, int Reserved. This value must be zero. Reserved) Retrieves a table that contains a list of UDP endpoints available to the application.
public int	Returns: If the function succeeds, the return value is `WinError#NO_ERROR`. GetIfEntry(IPHlpAPI.MIB_IFROW 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. pIfRow) The GetIfEntry function retrieves information for the specified interface on the local computer.
public int	Returns: If the function succeeds, the return value is `WinError#NO_ERROR`. GetIfEntry2(IPHlpAPI.MIB_IF_ROW2 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. pIfRow2) The GetIfEntry2 function retrieves information for the specified interface on the local computer.
public int	Returns: If the function succeeds, the return value is `WinError#ERROR_SUCCESS`. GetNetworkParams(Pointer 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. pFixedInfo, IntByReference 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 `WinError#ERROR_BUFFER_OVERFLOW`. pOutBufLen) The GetNetworkParams function retrieves network parameters for the local computer.
public int	Returns: If the function succeeds, the return value is `WinError#NO_ERROR`. GetTcpStatistics(IPHlpAPI.MIB_TCPSTATS A `MIB_TCPSTATS` structure that receives the TCP statistics for the local computer. Statistics) The GetTcpStatistics function retrieves the TCP statistics for the local computer.
public int	Returns: If the function succeeds, the return value is `WinError#NO_ERROR`. GetTcpStatisticsEx(IPHlpAPI.MIB_TCPSTATS A `MIB_TCPSTATS` structure that receives the TCP statistics for the local computer. Statistics, int The protocol family for which to retrieve statistics. This parameter must be `AF_INET` or `AF_INET6`. Family) The GetTcpStatisticsEx function retrieves the Transmission Control Protocol (TCP) statistics for the current computer.
public int	Returns: If the function succeeds, the return value is `WinError#NO_ERROR`. GetUdpStatistics(IPHlpAPI.MIB_UDPSTATS A `MIB_UDPSTATS` structure that receives the UDP statistics for the local computer. Statistics) The GetUdpStatistics function retrieves the User Datagram Protocol (UDP) statistics for the local computer.
public int	Returns: If the function succeeds, the return value is `WinError#NO_ERROR`. GetUdpStatisticsEx(IPHlpAPI.MIB_UDPSTATS A `MIB_UDPSTATS` structure that receives the UDP statistics for the local computer. Statistics, int The protocol family for which to retrieve statistics. This parameter must be `AF_INET` or `AF_INET6`. Family) The GetUdpStatisticsEx function retrieves the User Datagram Protocol (UDP) statistics for the current computer.