NdisPacketPoolUsage function

Article
06/19/2017

Note NDIS 5. x has been deprecated and is superseded by NDIS 6. x. For new NDIS driver development, see Network Drivers Starting with Windows Vista. For information about porting NDIS 5. x drivers to NDIS 6. x, see Porting NDIS 5.x Drivers to NDIS 6.0.

NdisPacketPoolUsage returns the number of packet descriptors currently allocated from a packet pool.

Syntax

UINT NdisPacketPoolUsage(
  _In_ NDIS_HANDLE PoolHandle
);

Parameters

PoolHandle [in]
Specifies a handle returned by NdisAllocatePacketPool or NdisAllocatePacketPoolEx.

Return value

NdisPacketPoolUsage returns the number of packet descriptors currently allocated from the given packet pool.

Remarks

Before allocating packet descriptors for a send or receive indication, an NDIS driver can call NdisPacketPoolUsage to determine whether it has enough spare packet descriptors available for the send or receive operation, particularly if the driver has allocated more than one packet pool.

An NDIS driver also can call this function to be sure that all descriptors have been returned to the given packet pool before it calls NdisFreePacketPool.

Requirements

Target platform	Universal
Version	Not supported for NDIS 6.0 drivers in Windows Vista. Supported for NDIS 5.1 drivers in Windows Vista and Windows XP.
Header	Ndis.h (include Ndis.h)
Library	Ndis.lib
IRQL	<= DISPATCH_LEVEL