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