Edit

Share via


PktMonClntHeaderInfoDrop function (pktmonclntk.h)

The PktMonClntHeaderInfoDrop function logs that a network packet was dropped.

Syntax

void PktMonClntHeaderInfoDrop(
  PKTMON_COMPONENT_CONTEXT         *CompContext,
  PKTMON_PACKET_TYPE               PacketType,
  PKTMON_PACKET_HEADER_INFORMATION *PacketHeaderInformation,
  PKTMON_DIRECTION                 Direction,
  INT                              DropReason,
  INT                              LocationCode,
  PKTMON_PACKET_CONTEXT_IN         *Context
);

Parameters

CompContext

Pointer to the PKTMON_COMPONENT_CONTEXT structure that holds the context for the component.

PacketType

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

PacketHeaderInformation

Pointer to a PKTMON_PACKET_HEADER_INFORMATION structure containing the packet header information.

Direction

Indicates the packet direction. Each component reports packets in two directions only, IN or OUT. Must be one of the values from 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 was dropped.

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

Context

Pointer to a PKTMON_PACKET_CONTEXT_IN structure containing the packet context. Can be NULL.

Return value

None

Requirements

Requirement Value
Header pktmonclntk.h

See also