NdisMInitiateOffloadComplete function (ndischimney.h)

  • Article

[The TCP chimney offload feature is deprecated and should not be used.]

An offload target calls the NdisMInitiateOffloadComplete function to complete an offload operation that was initiated by a previous call to the MiniportInitiateOffload function.

Syntax

void NdisMInitiateOffloadComplete(
  [in] IN NDIS_HANDLE                       NdisMiniportHandle,
  [in] IN PNDIS_MINIPORT_OFFLOAD_BLOCK_LIST OffloadBlockList
);

Parameters

[in] NdisMiniportHandle

The handle that the offload target obtained in a previous call to NdisMRegisterMiniportDriver.

[in] OffloadBlockList

A pointer to an NDIS_MINIPORT_OFFLOAD_BLOCK_LIST structure. The offload target obtained this pointer as an input parameter to its MiniportInitiateOffload function.

Return value

None

Remarks

Before calling NdisMInitiateOffloadComplete, the offload target must write one of the following NDIS_STATUS values to the Status member of each NDIS_MINIPORT_OFFLOAD_BLOCK_LIST structure in the state tree passed to the offload target's MiniportInitiateOffload function:

  • NDIS_STATUS_SUCCESS
  • NDIS_STATUS_PARTIAL_SUCCESS
  • NDIS_STATUS_RESOURCES
  • NDIS_STATUS_OFFLOAD_TCP_ENTRIES
  • NDIS_STATUS_OFFLOAD_PATH_ENTRIES
  • NDIS_STATUS_OFFLOAD_NEIGHBOR_ENTRIES
  • NDIS_STATUS_OFFLOAD_HW_ADDRESS_ENTRIES
  • NDIS_STATUS_OFFLOAD_IP_ADDRESS_ENTRIES
  • NDIS_STATUS_OFFLOAD_TCP_XMIT_BUFFER
  • NDIS_STATUS_OFFLOAD_TCP_RCV_BUFFER
  • NDIS_STATUS_OFFLOAD_TCP_RCV_WINDOW
  • NDIS_STATUS_OFFLOAD_VLAN_ENTRIES
  • NDIS_STATUS_OFFLOAD_PATH_MTU
  • NDIS_STATUS_FAILURE
For more information, see Returning Completion Status of an Initiate Offload Operation.

Requirements

Requirement Value
Target Platform Universal
Header ndischimney.h (include Ndischimney.h)
IRQL Any level

See also

MiniportInitiateOffload

NDIS_MINIPORT_OFFLOAD_BLOCK_LIST

NdisMRegisterMiniportDriver

NdisTcpOffloadEventHandler

NdisTcpOffloadReceiveHandler

OID_TCP_TASK_OFFLOAD