IP Helper Functions (Compact 2013)

3/26/2014

This section describes IP Helper functions

In This Section

Adapter Management Functions

  • GetPerAdapterInfo
    Retrieves information about the adapter that corresponds to the specified interface.

Address Resolution Protocol Management Functions

  • CreateIpNetEntry
    Creates an Address Resolution Protocol (ARP) entry in the ARP table on the local device.
  • CreateProxyArpEntry
    Creates a Proxy Address Resolution Protocol (PARP) entry on the local device for the specified IPv4 address.
  • DeleteProxyArpEntry
    Deletes the PARP entry on the local device specified by the dwAddress and dwIfIndex parameters.
  • FlushIpNetTable
    Deletes all ARP entries for the specified interface from the ARP table on the local device.
  • GetIpNetTable
    Retrieves the IP-to-physical address mapping table.
  • SendARP
    Sends an ARP request to obtain the physical address that corresponds to the specified destination IPv4 address.
  • SetIpNetEntry
    Modifies an existing ARP entry in the ARP table on the local device.

Interface Conversion Functions

  • if_indextoname
    Converts the local index for a network interface to the ANSI interface name.
  • if_nametoindex
    Converts the ANSI interface name for a network interface to the local index for the interface.

Interface Management Functions

  • GetFriendlyIfIndex
    Takes an interface index and returns a backward-compatible interface index, that is, an index that uses only the lower 24 bits.
  • GetIfEntry
    Retrieves information for the specified interface on the local device.
  • GetIfEntry2
    Retrieves information for the specified interface on the local device.
  • GetIfStackTable
    Retrieves a table of network interface stack row entries that specify the relationship of the network interfaces on an interface stack.
  • GetIfTable
    Retrieves the MIB-II interface table.
  • GetInterfaceInfo
    Obtains the list of the network interface adapters with IPv4 enabled on the local system.
  • GetInvertedIfStackTable
    Retrieves a table of inverted network interface stack row entries that specify the relationship of the network interfaces on an interface stack.
  • GetIpInterfaceEntry
    Retrieves IP information for the specified interface on the local device.
  • SetIfEntry
    Sets the administrative status of an interface.

IP and Internet Control Message Protocol Functions

  • GetIcmpStatistics
    Retrieves the Internet Control Message Protocol (ICMP) statistics for the local device.
  • Icmp6CreateFile
    Opens a handle on which IPv6 ICMP echo requests can be issued.
  • Icmp6ParseReplies
    Parses the reply buffer provided and returns an IPv6 ICMPv6 echo response reply if found.
  • Icmp6SendEcho2
    Sends an IPv6 ICMPv6 echo request and returns either immediately (if Event or ApcRoutine is non-NULL) or returns after the specified time-out.
  • IcmpCreateFile
    Opens a handle on which IPv4 ICMP echo requests can be issued.
  • IcmpParseReplies
    Parses the reply buffer provided and returns the number of ICMP echo request responses found.
  • IcmpSendEcho
    Sends an IPv4 ICMP echo request and returns any echo response replies The call returns when the time-out has expired or the reply buffer is filled.
  • IcmpSendEcho2
    Sends an IPv4 ICMP echo request and returns either immediately (if Event or ApcRoutine is non-NULL) or returns after the specified time-out.
  • SetIpTTL
    Sets the default Time to Live (TTL) value for the local device.

IP Address Management Functions

  • AddIPAddress
    Adds the specified IPv4 address to the specified adapter.
  • GetIpAddrTable
    Retrieves the interface-to-IPv4 address mapping table.
  • IpRenewAddress
    Renews a lease on an IPv4 address previously obtained through DHCP.

IP Neighbor Address Management Functions

  • GetIpNetEntry2
    Retrieves information for a neighbor IP address entry on the local device.
  • ResolveIpNetEntry2
    Resolves the physical address for a neighbor IP address entry on the local device.
  • ResolveNeighbor
    Deprecated.

    Resolves the physical address for a neighbor IP address entry on the local device.

  • SetIpNetEntry2
    Sets the physical address of an existing neighbor IP address entry on the local device.

IP Path Management Functions

  • GetIpPathEntry
    Retrieves information for an IP path entry on the local device.

IP Route Management Functions

  • EnableRouter
    Turns on IPv4 forwarding on the local device EnableRouter also increments a reference count that tracks the number of requests to enable IPv4 forwarding.
  • GetBestInterface
    Retrieves the index of the interface that has the best route to the specified IPv4 address.
  • GetBestInterfaceEx
    Retrieves the index of the interface that has the best route to the specified IPv4 or IPv6 address.
  • GetBestRoute
    Retrieves the best route to the specified destination IP address.
  • GetBestRoute2
    Retrieves the IP route entry on the local device for the best route to the specified destination IP address.
  • GetRTTAndHopCount
    Determines the round-trip time (RTT) and hop count to the specified destination.
  • SetIpForwardEntry
    Modifies an existing route in the local device's IPv4 routing table
  • SetIpStatistics
    Toggles IP forwarding on or off and sets the default Time to Live (TTL) value for the local device.
  • SetIpStatisticsEx
    Toggles IP forwarding on or off and sets the default Time to Live (TTL) value for the local device.
  • UnenableRouter
    This function decrements the reference count that tracks the number of requests to enable IPv4 forwarding.

IP Table Memory Management Functions

  • FreeMibTable
    This function frees the buffer allocated by the functions that return tables of network interfaces, addresses, and routes.

IP Utility Functions

  • CreateSortedAddressPairs
    Takes a supplied list of potential IP destination addresses, pairs the destination addresses together with the host machine's local IP addresses, and sorts the pairs according to which address pair is best suited for communication between the two peers.

Network Configuration Functions

Notification Functions

  • CancelMibChangeNotify2
    Deregisters for change notifications for IP interface changes, IP address changes, IP route changes, and requests to retrieve the stable Unicast IP address table.
  • NotifyAddrChange
    Causes a notification to be sent to the caller when a change occurs in the table that maps IPv4 addresses to interfaces.
  • NotifyIpInterfaceChange
    Registers to be notified for changes to all IP interfaces, IPv4 interfaces, or IPv6 interfaces on a local device.
  • NotifyRouteChange
    Causes a notification to be sent to the caller when a change occurs in the IPv4 routing table.
  • NotifyRouteChange2
    Registers to be notified for changes to IP route entries on a local device.
  • NotifyUnicastIpAddressChange
    Registers to be notified for changes to all unicast IP interfaces, unicast IPv4 addresses, or unicast IPv6 addresses on a local device.

TCP and UDP

  • GetExtendedTcpTable
    Retrieves a table that contains a list of TCP endpoints available to the application.
  • GetExtendedUdpTable
    Retrieves a table that contains a list of UDP endpoints available to the application.
  • GetOwnerModuleFromTcp6Entry
    Retrieves data about the module that issued the context bind for a specific IPv6 TCP endpoint in a MIB table row.
  • GetOwnerModuleFromTcpEntry
    Retrieves data about the module that issued the context bind for a specific IPv4 TCP endpoint in a MIB table row.
  • GetOwnerModuleFromUdp6Entry
    Retrieves data about the module that issued the context bind for a specific IPv6 UDP endpoint in a MIB table row.
  • GetOwnerModuleFromUdpEntry
    Retrieves data about the module that issued the context bind for a specific IPv4 UDP endpoint in a MIB table row.
  • GetTcpStatisticsEx
    Retrieves the Transmission Control Protocol (TCP) statistics for the current device.

Deprecated APIs

Note

These functions are deprecated and not supported by Microsoft

See Also

Reference

IP Helper Reference