NdisGetPacketFlags function

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.

NdisGetPacketFlags returns the flags, if any, set by a protocol driver in a given packet descriptor.

Syntax

UINT NdisGetPacketFlags(
  _In_ PNDIS_PACKET Packet
);

Parameters

  • Packet [in]
    Pointer to the packet.

Return value

NdisGetPacketFlags returns the value of the flags in the given packet descriptor. This function returns zero if the packet has no explictly set flags information.

Remarks

NdisGetPacketFlags returns information set in the flags packet descriptor that a protocol driver passes down to the underlying NDIS driver, usually with NdisSend or NdisSendPackets. These flags can contain protocol-determined information about the send that is not included in the packet data nor in the out-of-band block associated with the packet descriptor.

Protocol drivers can set the flags in packets to be sent on any medium that transmits data in an expedited manner. The MiniportSendPackets function of an underlying NIC driver calls NdisGetPacketFlags to retrieve this information. For underlying NIC drivers that do not support multipacket sends, calls to NdisGetPacketFlags are unnecessary because the packet flags value is passed as an input parameter to the MiniportSend function.

Requirements

Target platform

Desktop

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)

IRQL

Any level

See also

MiniportSend

MiniportSendPackets

MiniportWanSend

NDIS_PACKET

NDIS_PACKET_OOB_DATA

NdisSetPacketFlags

 

 

Send comments about this topic to Microsoft