NdisGetPacketFlags

This function returns the flags, if any, set by a protocol driver in a specified packet descriptor.

At a Glance

Header file: Ndis.h
Windows CE versions: 2.0 and later

Syntax

UINT NdisGetPacketFlags( IN PNDIS_PACKET Packet );

Parameters

Packet
Pointer to the packet.

Return Values

The value of the flags in the specified packet descriptor indicates success. Returns 0 if the packet has no explicitly set flags information.

Remarks

This functionreturns information set in the flags packet descriptor that a protocol driver passes down to the underlying NDIS driver, usually with the NdisSend function. 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 this function to retrieve this information. For underlying NIC drivers that do not support multipacket sends, calls to this function are unnecessary because the packet flags value is passed as an input parameter to the MiniportSend function.

A driver that calls this function can run at any IRQL.

See Also

NdisSetPacketFlags