NdisInitiateOffload function (ndischimney.h)

Article
02/22/2024

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

A protocol or intermediate driver calls the NdisInitiateOffload function to offload TCP chimney state objects.

Syntax

void NdisInitiateOffload(
  [in]      IN NDIS_HANDLE                           NdisBindingHandle,
  [in, out] IN OUT PNDIS_PROTOCOL_OFFLOAD_BLOCK_LIST OffloadBlockList
);

Parameters

[in] NdisBindingHandle

The handle that NDIS provided at the NdisBindingHandle parameter of NdisOpenAdapterEx. This handle identifies the binding between the caller and the underlying intermediate driver or offload target.

[in, out] OffloadBlockList

A pointer to an NDIS_PROTOCOL_OFFLOAD_BLOCK_LIST structure that can be a stand-alone structure or the root of a linked list of such structures. These structures identify the state that is being offloaded.

Return value

None

Remarks

An intermediate driver calls the NdisInitiateOffload function to propagate an initiate offload operation that was initiated by the host stack. For more information, see Propagating State-Manipulation Operations.

From the NDIS_MINIPORT_OFFLOAD_BLOCK_LIST structure that was passed to its MiniportInitiateOffload function, the intermediate driver constructs an NDIS_PROTOCOL_OFFLOAD_BLOCK_LIST structure. For more information, see Reusing an NDIS_MINIPORT_OFFLOAD_BLOCK_LIST Structure. The intermediate driver passes a pointer (the OffloadBlockList parameter) to this NDIS_PROTOCOL_OFFLOAD_BLOCK_LIST structure when calling the NdisInitiateOffload function.

Requirements

Requirement	Value
Target Platform	Universal
Header	ndischimney.h (include Ndischimney.h)
Library	Ndis.lib