Package com.sun.jna.platform.win32

Interface IPHlpAPI

    • 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 IPHlpAPI.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 IPHlpAPI.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 IPHlpAPI.MIB_IFROW to the index of the interface for which to retrieve information.
        Returns:
        If the function succeeds, the return value is WinError.NO_ERROR.

      • GetIfEntry2

        int GetIfEntry2​(IPHlpAPI.MIB_IF_ROW2 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 IPHlpAPI.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 IPHlpAPI.MIB_IF_ROW2 structure pointed to by the Row parameter are filled in.

        Parameters:
        pIfRow2 - A pointer to a IPHlpAPI.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 IPHlpAPI.MIB_IF_ROW2 must be set to the interface for which to retrieve information.
        Returns:
        If the function succeeds, the return value is WinError.NO_ERROR.

      • GetNetworkParams

        int GetNetworkParams​(Pointer pFixedInfo,
                     IntByReference pOutBufLen)
        The GetNetworkParams function retrieves network parameters for the local computer.
        Parameters:
        pFixedInfo - A pointer to a buffer that contains a IPHlpAPI.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 IPHlpAPI.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.
        Returns:
        If the function succeeds, the return value is WinError.ERROR_SUCCESS.

      • GetTcpStatistics

        int GetTcpStatistics​(IPHlpAPI.MIB_TCPSTATS Statistics)
        The GetTcpStatistics function retrieves the TCP statistics for the local computer.
        Parameters:
        Statistics - A IPHlpAPI.MIB_TCPSTATS structure that receives the TCP statistics for the local computer.
        Returns:
        If the function succeeds, the return value is WinError.NO_ERROR.

      • GetTcpStatisticsEx

        int GetTcpStatisticsEx​(IPHlpAPI.MIB_TCPSTATS Statistics,
                       int Family)
        The GetTcpStatisticsEx function retrieves the Transmission Control Protocol (TCP) statistics for the current computer. The GetTcpStatisticsEx function differs from the GetTcpStatistics(com.sun.jna.platform.win32.IPHlpAPI.MIB_TCPSTATS) function in that GetTcpStatisticsEx also supports the Internet Protocol version 6 (IPv6) protocol family.
        Parameters:
        Statistics - A IPHlpAPI.MIB_TCPSTATS structure that receives the TCP statistics for the local computer.
        Family - The protocol family for which to retrieve statistics. This parameter must be AF_INET or AF_INET6.
        Returns:
        If the function succeeds, the return value is WinError.NO_ERROR.

      • GetUdpStatistics

        int GetUdpStatistics​(IPHlpAPI.MIB_UDPSTATS Statistics)
        The GetUdpStatistics function retrieves the User Datagram Protocol (UDP) statistics for the local computer.
        Parameters:
        Statistics - A IPHlpAPI.MIB_UDPSTATS structure that receives the UDP statistics for the local computer.
        Returns:
        If the function succeeds, the return value is WinError.NO_ERROR.

      • GetUdpStatisticsEx

        int GetUdpStatisticsEx​(IPHlpAPI.MIB_UDPSTATS Statistics,
                       int Family)
        The GetUdpStatisticsEx function retrieves the User Datagram Protocol (UDP) statistics for the current computer. The GetUdpStatisticsEx function differs from the GetUdpStatistics(com.sun.jna.platform.win32.IPHlpAPI.MIB_UDPSTATS) function in that GetUdpStatisticsEx also supports the Internet Protocol version 6 (IPv6) protocol family.
        Parameters:
        Statistics - A IPHlpAPI.MIB_UDPSTATS structure that receives the UDP statistics for the local computer.
        Family - The protocol family for which to retrieve statistics. This parameter must be AF_INET or AF_INET6.
        Returns:
        If the function succeeds, the return value is WinError.NO_ERROR.