iphlpapi.h header

This header is used by IP Helper. For more information, see:

iphlpapi.h contains the following programming interfaces:

Functions

 
AddIPAddress

The AddIPAddress function adds the specified IPv4 address to the specified adapter.
AllocateAndGetTcpExTableFromStack

Retrieves the TCP connection table and allocates memory from the local heap to store the table.
AllocateAndGetUdpExTableFromStack

Retrieves the UDP connection table and allocates memory from the local heap to store the table.
CancelIPChangeNotify

Cancels notification of IPv4 address and route changes previously requested with successful calls to the NotifyAddrChange or NotifyRouteChange functions.
CaptureInterfaceHardwareCrossTimestamp

Retrieves cross timestamp info for a network adapter.
CreateIpForwardEntry

The CreateIpForwardEntry function creates a route in the local computer's IPv4 routing table.
CreateIpNetEntry

The CreateIpNetEntry function creates an Address Resolution Protocol (ARP) entry in the ARP table on the local computer.
CreatePersistentTcpPortReservation

Creates a persistent TCP port reservation for a consecutive block of TCP ports on the local computer.
CreatePersistentUdpPortReservation

Creates a persistent UDP port reservation for a consecutive block of UDP ports on the local computer.
CreateProxyArpEntry

The CreateProxyArpEnry function creates a Proxy Address Resolution Protocol (PARP) entry on the local computer for the specified IPv4 address.
DeleteIPAddress

The DeleteIPAddress function deletes an IP address previously added using AddIPAddress.
DeleteIpForwardEntry

Deletes an existing route in the local computer's IPv4 routing table.
DeleteIpNetEntry

The DeleteIpNetEntry function deletes an ARP entry from the ARP table on the local computer.
DeletePersistentTcpPortReservation

Deletes a persistent TCP port reservation for a consecutive block of TCP ports on the local computer.
DeletePersistentUdpPortReservation

Deletes a persistent TCP port reservation for a consecutive block of TCP ports on the local computer.
DeleteProxyArpEntry

The DeleteProxyArpEntry function deletes the PARP entry on the local computer specified by the dwAddress and dwIfIndex parameters.
DisableMediaSense

The DisableMediaSense function disables the media sensing capability of the TCP/IP stack on a local computer.
EnableRouter

The EnableRouter function turns on IPv4 forwarding on the local computer. EnableRouter also increments a reference count that tracks the number of requests to enable IPv4 forwarding.
FlushIpNetTable

The FlushIpNetTable function deletes all ARP entries for the specified interface from the ARP table on the local computer.
GetAdapterIndex

The GetAdapterIndex function obtains the index of an adapter, given its name.
GetAdapterOrderMap

The GetAdapterOrderMap function obtains an adapter order map that indicates priority for interfaces on the local computer.
GetAdaptersAddresses

Retrieves the addresses associated with the adapters on the local computer.
GetAdaptersInfo

The GetAdaptersInfo function retrieves adapter information for the local computer.
GetBestInterface

The GetBestInterface function retrieves the index of the interface that has the best route to the specified IPv4 address.
GetBestInterfaceEx

The GetBestInterfaceEx function retrieves the index of the interface that has the best route to the specified IPv4 or IPv6 address.
GetBestRoute

The GetBestRoute function retrieves the best route to the specified destination IP address.
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.
GetFriendlyIfIndex

Takes an interface index and returns a backward-compatible interface index, that is, an index that uses only the lower 24 bits.
GetIcmpStatistics

The GetIcmpStatistics function retrieves the Internet Control Message Protocol (ICMP) for IPv4 statistics for the local computer.
GetIcmpStatisticsEx

The GetIcmpStatisticsEx function retrieves Internet Control Message Protocol (ICMP) statistics for the local computer. The GetIcmpStatisticsEx function is capable of retrieving IPv6 ICMP statistics.
GetIfEntry

The GetIfEntry function retrieves information for the specified interface on the local computer.
GetIfTable

The GetIfTable function retrieves the MIB-II interface table.
GetInterfaceActiveTimestampCapabilities

Retrieves the currently enabled timestamp capabilities of a network adapter.
GetInterfaceInfo

The GetInterfaceInfo function obtains the list of the network interface adapters with IPv4 enabled on the local system.
GetInterfaceSupportedTimestampCapabilities

Retrieves the supported timestamp capabilities of a network adapter.
GetIpAddrTable

The GetIpAddrTable function retrieves the interface�to�IPv4 address mapping table.
GetIpErrorString

The GetIpErrorString function retrieves an IP Helper error string.
GetIpForwardTable

The GetIpForwardTable function retrieves the IPv4 routing table.
GetIpNetTable

The GetIpNetTable function retrieves the IPv4 to physical address mapping table.
GetIpStatistics

The GetIpStatistics function retrieves the IP statistics for the current computer.
GetIpStatisticsEx

The GetIpStatisticsEx function retrieves the Internet Protocol (IP) statistics for the current computer.
GetNetworkParams

The GetNetworkParams function retrieves network parameters for the local computer.
GetNumberOfInterfaces

The GetNumberOfInterfaces functions retrieves the number of interfaces on the local computer.
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.
GetPerAdapterInfo

The GetPerAdapterInfo function retrieves information about the adapter corresponding to the specified interface.
GetPerTcp6ConnectionEStats

Retrieves extended statistics for an IPv6 TCP connection.
GetPerTcpConnectionEStats

Retrieves extended statistics for an IPv4 TCP connection.
GetRTTAndHopCount

The GetRTTAndHopCount function determines the round-trip time (RTT) and hop count to the specified destination.
GetTcp6Table

Retrieves the TCP connection table for IPv6.
GetTcp6Table2

Retrieves the TCP connection table for IPv6.
GetTcpStatistics

The GetTcpStatistics function retrieves the TCP statistics for the local computer.
GetTcpStatisticsEx

The GetTcpStatisticsEx function retrieves the Transmission Control Protocol (TCP) statistics for the current computer.
GetTcpStatisticsEx2

The GetTcpStatisticsEx2 function retrieves the Transmission Control Protocol (TCP) statistics for the current computer.
GetTcpTable

Retrieves the IPv4 TCP connection table.
GetTcpTable2

Retrieves the IPv4 TCP connection table.
GetUdp6Table

Retrieves the IPv6 User Datagram Protocol (UDP) listener table.
GetUdpStatistics

The GetUdpStatistics function retrieves the User Datagram Protocol (UDP) statistics for the local computer.
GetUdpStatisticsEx

The GetUdpStatisticsEx function retrieves the User Datagram Protocol (UDP) statistics for the current computer.
GetUdpStatisticsEx2

The GetUdpStatisticsEx2 function retrieves the User Datagram Protocol (UDP) statistics for the current computer.
GetUdpTable

Retrieves the IPv4 User Datagram Protocol (UDP) listener table.
GetUniDirectionalAdapterInfo

The GetUniDirectionalAdapterInfo function retrieves information about the unidirectional adapters installed on the local computer. A unidirectional adapter is an adapter that can receive datagrams, but not transmit them.
IpReleaseAddress

The IpReleaseAddress function releases an IPv4 address previously obtained through the Dynamic Host Configuration Protocol (DHCP).
IpRenewAddress

The IpRenewAddressfunction renews a lease on an IPv4 address previously obtained through Dynamic Host Configuration Protocol (DHCP).
LookupPersistentTcpPortReservation

Looks up the token for a persistent TCP port reservation for a consecutive block of TCP ports on the local computer.
LookupPersistentUdpPortReservation

Looks up the token for a persistent UDP port reservation for a consecutive block of TCP ports on the local computer.
NhpAllocateAndGetInterfaceInfoFromStack

The NhpAllocateAndGetInterfaceInfoFromStack function obtains adapter information about the local computer.
NotifyAddrChange

The NotifyAddrChange function causes a notification to be sent to the caller whenever a change occurs in the table that maps IPv4 addresses to interfaces.
NotifyRouteChange

The NotifyRouteChange function causes a notification to be sent to the caller whenever a change occurs in the IPv4 routing table.
ParseNetworkString

Parses the input network string and checks whether it is a legal representation of the specified IP network string type. If the string matches a type and its specification, the function can optionally return the parsed result.
RegisterInterfaceTimestampConfigChange

Registers a user-implemented callback function, which the system calls to notify you of a timestamp capability change.
ResolveNeighbor

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

The RestoreMediaSense function restores the media sensing capability of the TCP/IP stack on a local computer on which the DisableMediaSense function was previously called.
SendARP

The SendARP function sends an Address Resolution Protocol (ARP) request to obtain the physical address that corresponds to the specified destination IPv4 address.
SetIfEntry

The SetIfEntry function sets the administrative status of an interface.
SetIpForwardEntry

The SetIpForwardEntry function modifies an existing route in the local computer's IPv4 routing table.
SetIpNetEntry

The SetIpNetEntry function modifies an existing ARP entry in the ARP table on the local computer.
SetIpStatistics

The SetIpStatistics function toggles IP forwarding on or off and sets the default time-to-live (TTL) value for the local computer.
SetIpStatisticsEx

Toggles IP forwarding on or off and sets the default time-to-live (TTL) value for the local computer.
SetIpTTL

The SetIpTTL function sets the default time-to-live (TTL) value for the local computer.
SetPerTcp6ConnectionEStats

Sets a value in the read/write information for an IPv6 TCP connection. This function is used to enable or disable extended statistics for an IPv6 TCP connection.
SetPerTcpConnectionEStats

Sets a value in the read/write information for an IPv4 TCP connection. This function is used to enable or disable extended statistics for an IPv4 TCP connection.
SetTcpEntry

The SetTcpEntry function sets the state of a TCP connection.
UnenableRouter

The UnenableRouter function decrements the reference count that tracks the number of requests to enable IPv4 forwarding. When this reference count reaches zero, UnenableRouter turns off IPv4 forwarding on the local computer.
UnregisterInterfaceTimestampConfigChange

Cancels notifications about timestamp capability changes by unregistering the callback function you registered in a call to RegisterInterfaceTimestampConfigChange.

Callback functions

 
INTERFACE_TIMESTAMP_CONFIG_CHANGE_CALLBACK

A callback function that you implement in your app in order to be notified of changes to the timestamp capabilities of a network adapter.

Structures

 
INTERFACE_HARDWARE_CROSSTIMESTAMP

Describes a cross timestamp retrieved from a network adapter.
INTERFACE_HARDWARE_TIMESTAMP_CAPABILITIES

Describes the timestamping capabilities of a network interface card's (NIC's) hardware.
INTERFACE_SOFTWARE_TIMESTAMP_CAPABILITIES

Describes the software timestamping capabilities of a NIC's miniport driver.
INTERFACE_TIMESTAMP_CAPABILITIES

Describes the exact timestamp capabilities that a network adapter supports.
NET_ADDRESS_INFO

Contains IP address information returned by the ParseNetworkString function.

Enumerations

 
NET_ADDRESS_FORMAT

The NET_ADDRESS_FORMAT enumeration specifies the format of a network address returned by the ParseNetworkString function.