netadapter.h header

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

netadapter.h contains the following programming interfaces:

Functions

 
NET_ADAPTER_DATAPATH_CALLBACKS_INIT

The NET_ADAPTER_DATAPATH_CALLBACKS_INIT function initializes a NET_ADAPTER_DATAPATH_CALLBACKS structure.
NET_ADAPTER_DMA_CAPABILITIES_INIT

The NET_ADAPTER_DMA_CAPABILITIES_INIT function initializes a NET_ADAPTER_DMA_CAPABILITIES structure.
NET_ADAPTER_LINK_LAYER_ADDRESS_INIT

The NET_ADAPTER_LINK_LAYER_ADDRESS_INIT function initializes a link layer address.
NET_ADAPTER_LINK_LAYER_CAPABILITIES_INIT

Initializes the NET_ADAPTER_LINK_LAYER_CAPABILITIES structure.
NET_ADAPTER_LINK_STATE_INIT

Initializes a NET_ADAPTER_LINK_STATE structure.
NET_ADAPTER_LINK_STATE_INIT_DISCONNECTED

Initializes a NET_ADAPTER_LINK_STATE structure for an adapter that is disconnected from the network.
NET_ADAPTER_OFFLOAD_CHECKSUM_CAPABILITIES_INIT

The NET_ADAPTER_OFFLOAD_CHECKSUM_CAPABILITIES_INIT function initializes a NET_ADAPTER_OFFLOAD_CHECKSUM_CAPABILITIES structure.
NET_ADAPTER_POWER_OFFLOAD_ARP_CAPABILITIES_INIT

The NET_ADAPTER_POWER_OFFLOAD_ARP_CAPABILITIES_INIT function initializes a NET_ADAPTER_POWER_OFFLOAD_ARP_CAPABILITIES structure.
NET_ADAPTER_POWER_OFFLOAD_NS_CAPABILITIES_INIT

The NET_ADAPTER_POWER_OFFLOAD_NS_CAPABILITIES_INIT function initializes a NET_ADAPTER_POWER_OFFLOAD_NS_CAPABILITIES structure.
NET_ADAPTER_RECEIVE_FILTER_CAPABILITIES_INIT

The NET_ADAPTER_RECEIVE_FILTER_CAPABILITIES_INIT function initializes a NET_ADAPTER_RECEIVE_FILTER_CAPABILITIES structure.
NET_ADAPTER_RX_CAPABILITIES_INIT_DRIVER_MANAGED

The NET_ADAPTER_RX_CAPABILITIES_INIT_DRIVER_MANAGED function initializes a NET_ADAPTER_RX_CAPABILITIES structure for a net adapter that would like to specify driver-managed receive buffer allocation and attachment.
NET_ADAPTER_RX_CAPABILITIES_INIT_SYSTEM_MANAGED

The NET_ADAPTER_RX_CAPABILITIES_INIT_SYSTEM_MANAGED function initializes a NET_ADAPTER_RX_CAPABILITIES structure for a net adapter that would like to specify operating system-managed receive buffer allocation and attachment, but not the use of DMA memory mapping.
NET_ADAPTER_RX_CAPABILITIES_INIT_SYSTEM_MANAGED_DMA

The NET_ADAPTER_RX_CAPABILITIES_INIT_SYSTEM_MANAGED_DMA function initializes a NET_ADAPTER_RX_CAPABILITIES structure for a net adapter that would like to specify operating system-managed receive buffer allocation and attachment, as well as DMA for memory mapping.
NET_ADAPTER_TX_CAPABILITIES_INIT

The NET_ADAPTER_TX_CAPABILITIES_INIT function initializes a NET_ADAPTER_TX_CAPABILITIES structure for a net adapter that has not specified the use of DMA in its transmit data path.
NET_ADAPTER_TX_CAPABILITIES_INIT_FOR_DMA

The NET_ADAPTER_TX_CAPABILITIES_INIT_FOR_DMA function initializes a NET_ADAPTER_TX_CAPABILITIES structure for a net adapter that has specified the use of DMA in its transmit data path.
NET_ADAPTER_WAKE_BITMAP_CAPABILITIES_INIT

The NET_ADAPTER_WAKE_BITMAP_CAPABILITIES_INIT function initializes a NET_ADAPTER_WAKE_BITMAP_CAPABILITIES structure.
NET_ADAPTER_WAKE_EAPOL_PACKET_CAPABILITIES_INIT

NET_ADAPTER_WAKE_EAPOL_PACKET_CAPABILITIES_INIT initializes a NET_ADAPTER_WAKE_EAPOL_PACKET_CAPABILITIES structure.
NET_ADAPTER_WAKE_MAGIC_PACKET_CAPABILITIES_INIT

The NET_ADAPTER_WAKE_MAGIC_PACKET_CAPABILITIES_INIT function initializes a NET_ADAPTER_WAKE_MAGIC_PACKET_CAPABILITIES structure.
NET_ADAPTER_WAKE_MEDIA_CHANGE_CAPABILITIES_INIT

The NET_ADAPTER_WAKE_MEDIA_CHANGE_CAPABILITIES_INIT function initializes a NET_ADAPTER_WAKE_MEDIA_CHANGE_CAPABILITIES structure.
NET_ADAPTER_WAKE_PACKET_FILTER_CAPABILITIES_INIT

The NET_ADAPTER_WAKE_PACKET_FILTER_CAPABILITIES_INIT function initializes a NET_ADAPTER_WAKE_PACKET_FILTER_CAPABILITIES structure.
NET_ADAPTER_WAKE_REASON_EAPOL_PACKET_INIT

NET_ADAPTER_WAKE_REASON_EAPOL_PACKET_INIT initializes a NET_ADAPTER_WAKE_EAPOL_PACKET_CAPABILITIES struct when reporting that a EAPOL packet caused a wake-up event.
NET_ADAPTER_WAKE_REASON_FILTER_PACKET_INIT

The NET_ADAPTER_WAKE_REASON_FILTER_PACKET_INIT function initializes a NET_ADAPTER_WAKE_REASON_PACKET when the wake source is a magic packet.
NET_ADAPTER_WAKE_REASON_MAGIC_PACKET_INIT

The NET_ADAPTER_WAKE_REASON_MAGIC_PACKET_INIT function initializes a NET_ADAPTER_WAKE_REASON_PACKET when the wake source is a magic packet.
NET_ADAPTER_WAKE_REASON_PACKET_INIT

The NET_ADAPTER_WAKE_REASON_PACKET_INIT function initializes a NET_ADAPTER_WAKE_REASON_PACKET structure.
NetAdapterCreate

Creates a NETADAPTER object.
NetAdapterGetNetLuid

Retrieves the NET_LUID that is assigned to a network adapter.
NetAdapterInitAllocate

The NetAdapterInitAllocate function allocates a NETADAPTER_INIT structure that a client driver uses when creating a new NETADAPTER object.
NetAdapterInitFree

The NetAdapterInitFree function deallocates a NETADAPTER_INIT structure.
NetAdapterInitSetDatapathCallbacks

The NetAdapterInitSetDatapathCallbacks function registers a NETADAPTER's callback functions for creating datapath packet queues.
NetAdapterLightweightInitAllocate

The NetAdapterLightweightInitAllocate function allocates a NETADAPTER_INIT structure that a client driver uses when creating a new NETADAPTER object for a deviceless adapter.
NetAdapterOffloadSetChecksumCapabilities

The NetAdapterOffloadSetChecksumCapabilities function sets the hardware checksum offload capabilities of a network adapter.
NetAdapterOpenConfiguration

Opens the adapter’s configuration database.
NetAdapterPowerOffloadSetArpCapabilities

The NetAdapterPowerOffloadSetArpCapabilities function sets a net adapter's capabilities for IPv4 ARP low power protocol offload.
NetAdapterPowerOffloadSetNSCapabilities

The NetAdapterPowerOffloadSetNsCapabilities function sets a net adapter's capabilities for IPv6 Neighbor Solicitation (NS) low power protocol offload.
NetAdapterReportWakeReasonMediaChange

The NetAdapterReportWakeReasonMediaChange function reports to the framework that a net adapter generated a wake-up event because of a media change.
NetAdapterReportWakeReasonPacket

The NetAdapterReportWakeReasonPacket function reports to the framework that a net adapter generated a wake-up event because it received a packet that matched a wake-on-LAN (WoL) pattern.
NetAdapterSetCurrentLinkLayerAddress

The NetAdapterSetCurrentLinkLayerAddress function sets the current link layer address for the network adapter.
NetAdapterSetDataPathCapabilities

Sets the data path capabilities of the network adapter.
NetAdapterSetLinkLayerCapabilities

Sets the link layer capabilities of the network adapter.
NetAdapterSetLinkLayerMtuSize

Sets the link layer maximum transfer unit size of the adapter.
NetAdapterSetLinkState

Sets the current link state of the of the network adapter.
NetAdapterSetPermanentLinkLayerAddress

The NetAdapterSetPermanentLinkLayerAddress function sets the permanent link layer address for the network adapter.
NetAdapterSetReceiveFilterCapabilities

NetAdapterSetReceiveFilterCapabilities sets the receive filtering capabilities of a network adapter.
NetAdapterStart

The NetAdapterStart function starts a NETADAPTER object.
NetAdapterStop

The NetAdapterStop function stops a NETADAPTER object.
NetAdapterWakeSetBitmapCapabilities

The NetAdapterWakeSetBitmapCapabilities function sets a net adapter's bitmap pattern wake on LAN (WoL) capabilities.
NetAdapterWakeSetEapolPacketCapabilities

NetAdapterWakeSetEapolPacketCapabilities sets a network adapter's EAPOL packet WoL capabilities.
NetAdapterWakeSetMagicPacketCapabilities

The NetAdapterWakeSetMagicPacketCapabilities function sets a net adapter's magic packet wake on LAN (WoL) capabilities.
NetAdapterWakeSetMediaChangeCapabilities

The NetAdapterWakeSetMediaChangeCapabilities function sets a net adapter's media change wake on LAN (WoL) capabilities.
NetAdapterWakeSetPacketFilterCapabilities

The NetAdapterWakeSetPacketFilterCapabilities function sets a net adapter's packet filter wake on LAN (WoL) capabilities.
NetReceiveFilterGetMulticastAddressCount

NetReceiveFilterGetMulticastAddressCount retrieves the number of addresses in the multicast address list.
NetReceiveFilterGetMulticastAddressList

NetReceiveFilterGetMulticastAddressList retrieves the list of addresses that can receive multicast packets.
NetReceiveFilterGetPacketFilter

NetReceiveFilterGetPacketFilter retrieves the NET_PACKET_FILTER_FLAGS which describe the packet filters the network adapter supports.

Callback functions

 
EVT_NET_ADAPTER_CREATE_RXQUEUE

The client driver's implementation of the EvtNetAdapterCreateRxQueue event callback function that sets up a receive (Rx) queue.
EVT_NET_ADAPTER_CREATE_TXQUEUE

The client driver's implementation of the EvtNetAdapterCreateTxQueue event callback function that sets up a transmit (Tx) queue.
EVT_NET_ADAPTER_OFFLOAD_SET_CHECKSUM

The EvtNetAdapterOffloadSetChecksum callback function is implemented by the client driver to set changes in checksum offload capabilities.
EVT_NET_ADAPTER_RETURN_RX_BUFFER

Implement this optional callback function to perform cleanup on a receive buffer for which you previously specified manual fragment allocation and attachment.
EVT_NET_ADAPTER_SET_RECEIVE_FILTER

The client driver implements EvtNetAdapterSetReceiveFilter to set changes in a network adapter's active receive filtering capabilities.

Structures

 
NET_ADAPTER_DATAPATH_CALLBACKS

The NET_ADAPTER_DATAPATH_CALLBACKS structure describes a net adapter's callback functions for creating its datapath queues.
NET_ADAPTER_DMA_CAPABILITIES

The NET_ADAPTER_DMA_CAPABILITIES structure describes the DMA capabilities of an adapter.
NET_ADAPTER_LINK_LAYER_ADDRESS

A NET_ADAPTER_LINK_LAYER_ADDRESS structure describes a link layer address.
NET_ADAPTER_LINK_LAYER_CAPABILITIES

Describes the link layer capabilities of the adapter.
NET_ADAPTER_LINK_STATE

Describes the link state of the adapter.
NET_ADAPTER_OFFLOAD_CHECKSUM_CAPABILITIES

The NET_ADAPTER_OFFLOAD_CHECKSUM_CAPABILITIES structure describes a network interface card (NIC)'s capabilities for offloading checksum calculation and validation.
NET_ADAPTER_POWER_OFFLOAD_ARP_CAPABILITIES

The NET_ADAPTER_POWER_OFFLOAD_ARP_CAPABILITIES structure describes a net adapter's capabilities for IPv4 ARP low power protocol offload.
NET_ADAPTER_POWER_OFFLOAD_NS_CAPABILITIES

The NET_ADAPTER_POWER_OFFLOAD_NS_CAPABILITIES structure describes a net adapter's capabilities for IPv6 Neighbor Solicitation (NS) low power protocol offload.
NET_ADAPTER_RECEIVE_FILTER_CAPABILITIES

The NET_ADAPTER_RECEIVE_FILTER_CAPABILITIES structure specifies a NIC's receive filtering capabilities.
NET_ADAPTER_RX_CAPABILITIES

The NET_ADAPTER_RX_CAPABILITIES structure describes the receive capabilities of a net adapter.
NET_ADAPTER_TX_CAPABILITIES

The NET_ADAPTER_TX_CAPABILITIES structure describes the transmit capabilities of a net adapter.
NET_ADAPTER_WAKE_BITMAP_CAPABILITIES

The NET_ADAPTER_WAKE_BITMAP_CAPABILITIES structure describes a net adapter's wake on LAN (WoL) capabilities for waking from a bitmap pattern.
NET_ADAPTER_WAKE_EAPOL_PACKET_CAPABILITIES

NET_ADAPTER_WAKE_EAPOL_PACKET_CAPABILITIES describes a network adapter's WoL capabilities for waking from an EAPOL packet.
NET_ADAPTER_WAKE_MAGIC_PACKET_CAPABILITIES

The NET_ADAPTER_WAKE_MAGIC_PACKET_CAPABILITIES structure describes a net adapter's wake on LAN (WoL) capabilities for waking from a magic packet.
NET_ADAPTER_WAKE_MEDIA_CHANGE_CAPABILITIES

The NET_ADAPTER_WAKE_MEDIA_CHANGE_CAPABILITIES structure describes a net adapter's wake on LAN (WoL) capabilities for waking from a media change event.
NET_ADAPTER_WAKE_PACKET_FILTER_CAPABILITIES

The NET_ADAPTER_WAKE_PACKET_FILTER_CAPABILITIES structure describes a net adapter's wake on LAN (WoL) capabilities for waking from a packet filter match.
NET_ADAPTER_WAKE_REASON_PACKET

The NET_ADAPTER_WAKE_REASON_PACKET structure describes a network packet (known as a wake packet) that caused the network adapter to generate a wake-up event.

Enumerations

 
NET_ADAPTER_AUTO_NEGOTIATION_FLAGS

Specifies the auto-negotiation settings for the NIC driver.
NET_ADAPTER_PAUSE_FUNCTION_TYPE

The NET_ADAPTER_PAUSE_FUNCTION_TYPE enumeration specifies what IEEE 802.3 pause frames a net adapter supports.
NET_ADAPTER_WAKE_PATTERN_ID

NET_ADAPTER_WAKE_PATTERN_ID is used to specify the wake pattern ID in the NET_ADAPTER_WAKE_REASON_PACKET structure.
NET_MEMORY_MAPPING_REQUIREMENT

The NET_MEMORY_MAPPING_REQUIREMENT enumeration identifies the memory mapping requirement that a net adapter can specify for its receive and transmit buffers.
NET_PACKET_FILTER_FLAGS

NET_PACKET_FILTER_FLAGS describe a network adapter's receive packet filters.
NET_RX_FRAGMENT_BUFFER_ALLOCATION_MODE

The NET_RX_FRAGMENT_BUFFER_ALLOCATION_MODE enumeration identifies how the operating system should allocate NET_PACKET_FRAGMENT receive buffers for a net adapter client driver's receive queues.
NET_RX_FRAGMENT_BUFFER_ATTACHMENT_MODE

The NET_RX_FRAGMENT_BUFFER_ATTACHMENT_MODE enumeration identifies how the operating system should pre-attach NET_PACKET_FRAGMENT buffers to NET_PACKETs for a net adapter client driver's receive queues.