Edit

Share via


netioapi.h header

This header is used by multiple technologies. For more information, see:

netioapi.h contains the following programming interfaces:

Functions

 
CancelMibChangeNotify2

Deregisters for change notifications for IP interface changes, IP address changes, IP route changes, Teredo port changes, and when the unicast IP address table is stable and can be retrieved.
ConvertInterfaceAliasToLuid

Converts an interface alias name for a network interface to the locally unique identifier (LUID) for the interface.
ConvertInterfaceGuidToLuid

Converts a globally unique identifier (GUID) for a network interface to the locally unique identifier (LUID) for the interface.
ConvertInterfaceIndexToLuid

Converts a local index for a network interface to the locally unique identifier (LUID) for the interface.
ConvertInterfaceLuidToAlias

Converts a locally unique identifier (LUID) for a network interface to an interface alias.
ConvertInterfaceLuidToGuid

Converts a locally unique identifier (LUID) for a network interface to a globally unique identifier (GUID) for the interface.
ConvertInterfaceLuidToIndex

Converts a locally unique identifier (LUID) for a network interface to the local index for the interface.
ConvertInterfaceLuidToNameA

Converts a locally unique identifier (LUID) for a network interface to the ANSI interface name.
ConvertInterfaceLuidToNameW

Converts a locally unique identifier (LUID) for a network interface to the Unicode interface name.
ConvertInterfaceNameToLuidA

Converts an ANSI network interface name to the locally unique identifier (LUID) for the interface.
ConvertInterfaceNameToLuidW

Converts a Unicode network interface name to the locally unique identifier (LUID) for the interface.
ConvertIpv4MaskToLength

Converts an IPv4 subnet mask to an IPv4 prefix length.
ConvertLengthToIpv4Mask

Converts an IPv4 prefix length to an IPv4 subnet mask.
CreateAnycastIpAddressEntry

Adds a new anycast IP address entry on the local computer.
CreateIpForwardEntry2

Creates a new IP route entry on the local computer.
CreateIpNetEntry2

Creates a new neighbor IP address entry on the local computer.
CreateSortedAddressPairs

Takes a supplied list of potential IP destination addresses, pairs the destination addresses 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.
CreateUnicastIpAddressEntry

Adds a new unicast IP address entry on the local computer.
DeleteAnycastIpAddressEntry

Deletes an existing anycast IP address entry on the local computer.
DeleteIpForwardEntry2

Deletes an IP route entry on the local computer.
DeleteIpNetEntry2

Deletes a neighbor IP address entry on the local computer.
DeleteUnicastIpAddressEntry

Deletes an existing unicast IP address entry on the local computer.
FlushIpNetTable2

The FlushIpNetTable2 function flushes the IP neighbor table on the local computer.
FlushIpPathTable

The FlushIpPathTable function flushes the IP path table on the local computer.
FreeInterfaceDnsSettings

Frees the settings object returned by GetInterfaceDnsSettings.
FreeMibTable

Frees the buffer allocated by the functions that return tables of network interfaces, addresses, and routes (GetIfTable2 and GetAnycastIpAddressTable, for example).
GetAnycastIpAddressEntry

Retrieves information for an existing anycast IP address entry on the local computer.
GetAnycastIpAddressTable

Retrieves the anycast IP address table on the local computer.
GetBestRoute2

Retrieves the IP route entry on the local computer for the best route to the specified destination IP address.
GetCurrentThreadCompartmentId

Reserved for future use. Do not use this function. (GetCurrentThreadCompartmentId)
GetDefaultCompartmentId

The GetDefaultCompartmentId function retrieves the default network routing compartment identifier for the local computer.
GetIfEntry2

Retrieves information for the specified interface on the local computer.
GetIfEntry2Ex

Retrieves the specified level of information for the specified interface on the local computer.
GetIfStackTable

Retrieves a table of network interface stack row entries that specify the relationship of the network interfaces on an interface stack.
GetIfTable2

Retrieves the MIB-II interface table. (GetIfTable2)
GetIfTable2Ex

Retrieves the MIB-II interface table. (GetIfTable2Ex)
GetInterfaceDnsSettings

Retrieves the DNS settings from the interface specified in the Interface parameter.
GetInvertedIfStackTable

Retrieves a table of inverted network interface stack row entries that specify the relationship of the network interfaces on an interface stack.
GetIpForwardEntry2

Retrieves information for an IP route entry on the local computer.
GetIpForwardTable2

The GetIpForwardTable2 function retrieves the IP route entries on the local computer.
GetIpInterfaceEntry

Retrieves IP information for the specified interface on the local computer.
GetIpInterfaceTable

Retrieves the IP interface entries on the local computer.
GetIpNetEntry2

Retrieves information for a neighbor IP address entry on the local computer.
GetIpNetTable2

The GetIpNetTable2 function retrieves the IP neighbor table on the local computer.
GetIpNetworkConnectionBandwidthEstimates

Retrieves historical bandwidth estimates for a network connection on the specified interface.
GetIpPathEntry

Retrieves information for a IP path entry on the local computer.
GetIpPathTable

The GetIpPathTable function retrieves the IP path table on the local computer.
GetMulticastIpAddressEntry

Retrieves information for an existing multicast IP address entry on the local computer.
GetMulticastIpAddressTable

Retrieves the multicast IP address table on the local computer.
GetNetworkConnectivityHint

Retrieves the aggregate level and cost of network connectivity that an application or service is likely to experience.
GetNetworkConnectivityHintForInterface

Retrieves the level and cost of network connectivity for the specified interface.
GetNetworkInformation

Reserved for future use. Do not use this function. (GetNetworkInformation)
GetSessionCompartmentId

Reserved for future use. Do not use this function. (GetSessionCompartmentId)
GetTeredoPort

Retrieves the dynamic UDP port number used by the Teredo client on the local computer.
GetUnicastIpAddressEntry

Retrieves information for an existing unicast IP address entry on the local computer.
GetUnicastIpAddressTable

Retrieves the unicast IP address table on the local computer.
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.
InitializeIpForwardEntry

Initializes a MIB_IPFORWARD_ROW2 structure with default values for an IP route entry on the local computer.
InitializeIpInterfaceEntry

Initializes the members of an MIB_IPINTERFACE_ROW entry with default values.
InitializeUnicastIpAddressEntry

Initializes a MIB_UNICASTIPADDRESS_ROW structure with default values for a unicast IP address entry on the local computer.
NotifyIpInterfaceChange

Registers to be notified for changes to all IP interfaces, IPv4 interfaces, or IPv6 interfaces on a local computer.
NotifyNetworkConnectivityHintChange

Registers an application-defined callback function, to be called when the aggregate network connectivity level and cost hints change.
NotifyRouteChange2

Registers to be notified for changes to IP route entries on a local computer.
NotifyStableUnicastIpAddressTable

Retrieves the stable unicast IP address table on a local computer.
NotifyTeredoPortChange

Registers to be notified for changes to the UDP port number used by the Teredo client for the Teredo service port on a local computer.
NotifyUnicastIpAddressChange

Registers to be notified for changes to all unicast IP interfaces, unicast IPv4 addresses, or unicast IPv6 addresses on a local computer.
ResolveIpNetEntry2

Resolves the physical address for a neighbor IP address entry on the local computer. (ResolveIpNetEntry2)
SetCurrentThreadCompartmentId

Reserved for future use. Do not use this function. (SetCurrentThreadCompartmentId)
SetInterfaceDnsSettings

Sets the per-interface DNS settings specified in the Settings parameter.
SetIpForwardEntry2

Sets the properties of an IP route entry on the local computer.
SetIpInterfaceEntry

Sets the properties of an IP interface on the local computer.
SetIpNetEntry2

Sets the physical address of an existing neighbor IP address entry on the local computer.
SetNetworkInformation

Reserved for future use. Do not use this function. (SetNetworkInformation)
SetSessionCompartmentId

Reserved for future use. Do not use this function. (SetSessionCompartmentId)
SetUnicastIpAddressEntry

Sets the properties of an existing unicast IP address entry on the local computer.

Callback functions

 
PNETWORK_CONNECTIVITY_HINT_CHANGE_CALLBACK

An application-defined function called whenever there's a change in the network aggregate connectivity level and cost hints.

Structures

 
DNS_DOH_SERVER_SETTINGS

Describes a DNS-over-HTTPS server.
DNS_INTERFACE_SETTINGS

Represents the DNS settings that can be configured on a given interface by calling the SetInterfaceDnsSettings function or retrieved for a given interface by calling the GetInterfaceDnsSettings function. (DNS_INTERFACE_SETTINGS)
DNS_INTERFACE_SETTINGS_EX

Represents the DNS settings that can be configured on a given interface by calling the SetInterfaceDnsSettings function or retrieved for a given interface by calling the GetInterfaceDnsSettings function. (DNS_INTERFACE_SETTINGS_EX)
DNS_INTERFACE_SETTINGS3

Represents the DNS settings that can be configured on a given interface by calling the SetInterfaceDnsSettings function or retrieved for a given interface by calling the GetInterfaceDnsSettings function. (DNS_INTERFACE_SETTINGS3)
DNS_SERVER_PROPERTY

Describes a DNS server property, which is set in the DNS_INTERFACE_SETTINGS3 structure, and configured through the SetInterfaceDnsSettings function.
DNS_SERVER_PROPERTY_TYPES

Contains a pointer to a DNS server property. The type of the property depends on the value of DNS_SERVER_PROPERTY::Type.
IP_ADDRESS_PREFIX

Stores an IP address prefix. (IP_ADDRESS_PREFIX)
MIB_ANYCASTIPADDRESS_ROW

Stores information about an anycast IP address.
MIB_ANYCASTIPADDRESS_TABLE

Contains a table of anycast IP address entries.
MIB_IF_ROW2

Stores information about a particular interface. (MIB_IF_ROW2)
MIB_IF_TABLE2

Contains a table of logical and physical interface entries.
MIB_IFSTACK_ROW

Represents the relationship between two network interfaces. (MIB_IFSTACK_ROW)
MIB_IFSTACK_TABLE

Contains a table of network interface stack row entries. This specifies the relationship of the network interfaces on an interface stack.
MIB_INVERTEDIFSTACK_ROW

Represents the relationship between two network interfaces. (MIB_INVERTEDIFSTACK_ROW)
MIB_INVERTEDIFSTACK_TABLE

Contains a table of inverted network interface stack row entries. This specifies the relationship of the network interfaces on an interface stack in reverse order.
MIB_IP_NETWORK_CONNECTION_BANDWIDTH_ESTIMATES

Contains read-only information for the bandwidth estimates computed by the TCP/IP stack for a network connection.
MIB_IPFORWARD_ROW2

Stores information about an IP route entry.
MIB_IPFORWARD_TABLE2

Contains a table of IP route entries.
MIB_IPINTERFACE_ROW

Stores interface management information for a particular IP address family on a network interface.
MIB_IPINTERFACE_TABLE

Contains a table of IP interface entries.
MIB_IPNET_ROW2

Stores information about a neighbor IP address.
MIB_IPNET_TABLE2

Contains a table of neighbor IP address entries.
MIB_IPPATH_ROW

Stores information about an IP path entry.
MIB_IPPATH_TABLE

Contains a table of IP path entries.
MIB_MULTICASTIPADDRESS_ROW

Stores information about a multicast IP address.
MIB_MULTICASTIPADDRESS_TABLE

Contains a table of multicast IP address entries.
MIB_UNICASTIPADDRESS_ROW

Stores information about a unicast IP address.
MIB_UNICASTIPADDRESS_TABLE

Contains a table of unicast IP address entries.

Enumerations

 
DNS_SERVER_PROPERTY_TYPE

Defines constants that specify the validity of the property held in the DNS_SERVER_PROPERTY::Property member.
MIB_IF_TABLE_LEVEL

The MIB_IF_TABLE_LEVEL enumeration type defines the level of interface information to retrieve.
MIB_NOTIFICATION_TYPE

Defines the notification type passed to a callback function when a notification occurs.