Edit

Share via


PktMonClntNblDrop function (pktmonclntk.h)

The PktMonClntNblDrop function logs that a network packet was dropped. Additional information can be provided about why and where it got dropped.

Syntax

void PktMonClntNblDrop(
  PKTMON_COMPONENT_CONTEXT         *CompContext,
  PNET_BUFFER_LIST                 NetBufferList,
  PKTMON_PACKET_TYPE               PacketType,
  PKTMON_PACKET_HEADER_INFORMATION *PacketHeaderInformation,
  BOOLEAN                          UseOnlyFirstNbl,
  PKTMON_DIRECTION                 Direction,
  INT                              DropReason,
  INT                              LocationCode
);

Parameters

CompContext

Pointer to PKTMON_COMPONENT_CONTEXT which holds the context for the component.

NetBufferList

Pointer to the NET_BUFFER_LIST structure.

PacketType

The type of packet being logged. This must be one of the values defined in the PKTMON_PACKET_TYPE enumeration.

PacketHeaderInformation

Pointer to the PKTMON_PACKET_HEADER_INFORMATION structure containing the packet header information. Can be NULL.

UseOnlyFirstNbl

When TRUE, indicates that only the first NBL in NetBufferList was dropped. Otherwise, all NBLs were dropped.

Direction

Indicates the packet direction. Each component reports packets in two directions only, IN or OUT. Must be one of the values from the PKTMON_DIRECTION enumeration.

DropReason

Integer that indicates the reason for the packet to be dropped.

Value Usage
0 - 0x7FFFFFFF Reserved for Microsoft.
0x80000000 - 0xFFFFFFFF Free to be used.

LocationCode

Integer that indicates the location where the packet got dropped.

Value Usage
0 - 0x7FFFFFFF Free to be used.
0x80000000 - 0xFFFFFFFF Reserved for Microsoft.

Return value

None

Requirements

Requirement Value
Header pktmonclntk.h

See also