IP Helper Functions

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

The following table shows the IP Helper functions with a description of the purpose of each.

Programming element	Description
AddIPAddress	This function adds the specified IP address to the specified adapter.
CreateIpForwardEntry	This function creates a route in the local computer's IP routing table.
CreateIpNetEntry	This function creates an Address Resolution Protocol (ARP) entry in the ARP table on the local computer.
CreateProxyArpEntry	This function creates a Proxy Address Resolution Protocol (PARP) entry on the local computer for the specified IP address.
DeleteIPAddress	Use this function to delete an IP address that was previously added using AddIPAddress.
DeleteIpForwardEntry	This function deletes an existing route in the local computer's IP routing table.
DeleteIpNetEntry	This function deletes an ARP entry from the ARP table on the local computer.
DeleteProxyArpEntry	This function deletes the PARP entry on the local computer specified by the dwAddress and dwIfIndex parameters.
FlushIpNetTable	This function deletes all ARP entries for the specified interface from the ARP table on the local computer.
GetAdapterIndex	This function obtains the index of an adapter, given its name.
GetAdaptersAddresses	This function retrieves the addresses associated with the adapters on the local computer.
GetAdaptersInfo	This function retrieves adapter information for the local computer. This function is deprecated in favor of GetAdaptersAddresses.
GetBestInterface	This function retrieves the index of the interface that has the best route to the specified IP address.
GetBestInterfaceEx	This function retrieves the index of the interface that has the best route to the specified IP address.
GetBestRoute	This function retrieves the best route to the specified destination IP address.
GetFriendlyIfIndex	This function takes an interface index and returns a backward-compatible interface index, that is, one that uses only the lower 24 bits.
GetIcmpStatistics	This function retrieves the Internet Control Message Protocol (ICMP) statistics for the local computer.
GetIcmpStatisticsEx	This function retrieves the Internet Control Message Protocol (ICMP) statistics for the current computer.
GetIfEntry	This function retrieves information for the specified interface on the local computer.
GetIfTable	This function retrieves the MIB-II interface table.
GetInterfaceInfo	This function obtains a list of the network interface adapters on the local system.
GetIpAddrTable	This function retrieves the interface–to–IP address mapping table.
GetIpForwardTable	This function retrieves the IP routing table.
GetIpNetTable	This function retrieves the IP-to-physical address mapping table.
GetIpStatistics	This function retrieves the IP statistics for the current computer.
GetIpStatisticsEx	This function retrieves the Internet Protocol (IP) statistics for the current computer.
GetNetworkParams	This function retrieves network parameters for the local computer.
GetNumberOfInterfaces	This function retrieves the number of interfaces on the local computer.
GetPerAdapterInfo	This function retrieves information about the adapter corresponding to the specified interface.
GetRTTAndHopCount	This function determines the round-trip time (RTT) and hop count to the specified destination.
GetTcpStatistics	This function retrieves the TCP statistics for the local computer.
GetTcpStatisticsEx	This function retrieves the Transmission Control Protocol (TCP) statistics for the current computer.
GetTcpTable	This function retrieves the TCP connection table.
GetUdpStatistics	This function retrieves the User Datagram Protocol (UDP) statistics for the local computer.
GetUdpStatisticsEx	This function retrieves the User Datagram Protocol (UDP) statistics for the current computer.
GetUdpTable	This function retrieves the User Datagram Protocol (UDP) listener table.
GetUniDirectionalAdapterInfo	This function retrieves information about the unidirectional adapters installed on the local computer.
IpReleaseAddress	This function releases an IP address previously obtained through Dynamic Host Configuration Protocol (DHCP).
IpRenewAddress	This function renews a lease on an IP address previously obtained through Dynamic Host Configuration Protocol (DHCP).
NotifyAddrChange	This function causes a notification to be sent to the caller whenever a change occurs in the table that maps IP addresses to interfaces.
NotifyRouteChange	This function causes a notification to be sent to the caller whenever a change occurs in the IP routing table.
SendARP	This function sends an ARP request to obtain the physical address that corresponds to the specified destination IP address.
SetIfEntry	This function is used to set the administrative status of an interface.
SetIpForwardEntry	This function modifies an existing route in the local computer's IP routing table. It can also add a new route to the routing table.
SetIpNetEntry	This function modifies an existing ARP entry in the ARP table on the local computer.
SetIpStatistics	This function toggles IP forwarding on or off and sets the default time-to-live (TTL) value for the local computer.
SetIpTTL	This function sets the default time-to-live (TTL) value for the local computer.
SetTcpEntry	This function sets the state of a TCP connection.

See Also

Reference

IP Helper Reference