FwpsGetPacketListSecurityInformation0 function (fwpsk.h)

Article
10/21/2021

The FwpsGetPacketListSecurityInformation0 function retrieves information associated with a packet list.

Note FwpsGetPacketListSecurityInformation0 is a specific version of FwpsGetPacketListSecurityInformation. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Syntax

NTSTATUS FwpsGetPacketListSecurityInformation0(
  [in]      NET_BUFFER_LIST               *packetList,
  [in]      UINT32                        queryFlags,
  [in, out] FWPS_PACKET_LIST_INFORMATION0 *packetInformation
);

Parameters

[in] packetList

A pointer to the NET_BUFFER_LIST structure for which the associated information is being retrieved.

[in] queryFlags

A UINT32 value that contains a bitwise OR of a combination of the following flags that specify the information to be retrieved:

FWPS_PACKET_LIST_INFORMATION_QUERY_INBOUND

Retrieve information for an inbound packet list.

FWPS_PACKET_LIST_INFORMATION_QUERY_OUTBOUND

Retrieve information for an outbound packet list.

FWPS_PACKET_LIST_INFORMATION_QUERY_IPSEC

Retrieve the IPsec information associated with the packet list. This flag must be used in combination with either the FWPS_PACKET_LIST_INFORMATION_QUERY_INBOUND flag or the FWPS_PACKET_LIST_INFORMATION_QUERY_OUTBOUND flag.

FWPS_PACKET_LIST_INFORMATION_QUERY_FWP

Retrieve the Windows Filtering Platform information associated with the packet list.

FWPS_PACKET_LIST_INFORMATION_QUERY_ALL_INBOUND

Retrieve all information associated with an inbound packet list.

FWPS_PACKET_LIST_INFORMATION_QUERY_ALL_OUTBOUND

Retrieve all information associated with an outbound packet list.

[in, out] packetInformation

A pointer to an FWPS_PACKET_LIST_INFORMATION0 structure that receives the information associated with the packet list.

Return value

The FwpsGetPacketListSecurityInformation0 function returns one of the following NTSTATUS codes.

Return code	Description
STATUS_SUCCESS	The information associated with the packet list was successfully retrieved.
Other status codes	An error occurred.

Remarks

A callout driver calls the FwpsGetPacketListSecurityInformation0 function from within its classifyFn callout function to retrieve information associated with the packet list. This information can be used to determine the action to be taken on the data.

Requirements

Requirement	Value
Minimum supported client	Available starting with Windows Vista.
Target Platform	Universal
Header	fwpsk.h (include Fwpsk.h)
Library	Fwpkclnt.lib
IRQL	<= DISPATCH_LEVEL