NdisFreeScatterGatherList function (ndis.h)

The NdisFreeScatterGatherList function frees a scatter/gather list.

Syntax

void NdisFreeScatterGatherList(
  [in] IN NDIS_HANDLE          NdisHandle,
  [in] IN PSCATTER_GATHER_LIST ScatterGatherListBuffer,
  [in] IN BOOLEAN              WriteToDevice
);

Parameters

[in] NdisHandle

An NDIS driver or instance handle that was obtained during caller initialization. This should be the same handle that was passed to the NdisBuildScatterGatherList function when the scatter/gather list was created.

[in] ScatterGatherListBuffer

A pointer to a caller-provided SCATTER_GATHER_LIST structure to free. This must be the same buffer that was passed to the NdisBuildScatterGatherList function when the scatter/gather list was allocated.

[in] WriteToDevice

A BOOLEAN value that is set to TRUE if the scatter/gather list was used for writing to the device. Otherwise, it is FALSE.

Return value

None

Remarks

NDIS drivers call the NdisFreeScatterGatherList function to free a scatter/gather list that was created with the NdisBuildScatterGatherList function.

Requirements

Requirement Value
Minimum supported client Supported in NDIS 6.20 and later.
Target Platform Universal
Header ndis.h (include Ndis.h)
Library Ndis.lib
IRQL = DISPATCH_LEVEL

See also

NdisBuildScatterGatherList

SCATTER_GATHER_LIST