FwpsNetBufferListRemoveContext0 function (fwpsk.h)

Article
02/22/2024

The FwpsNetBufferListRemoveContext0 function removes the context associated with a network buffer list.

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

Syntax

NTSTATUS FwpsNetBufferListRemoveContext0(
  [in, out, optional] NET_BUFFER_LIST *netBufferList,
  [in]                UINT64          contextTag,
  [in]                UINT32          flags
);

Parameters

[in, out, optional] netBufferList

A network buffer list that indicates one or more packets of interest to the callout driver. This parameter is optional and can be NULL. If it is NULL, the function will remove the context from all associated network buffer lists.

[in] contextTag

The context tag that was passed in the contextTag parameter to FwpsNetBufferListAssociateContext0.

[in] flags

This parameter is reserved for future use and must be zero.

Return value

The FwpsNetBufferListRemoveContext0 function returns one of the following NTSTATUS codes.

Return code	Description
STATUS_SUCCESS	The context was successfully removed.
Other status codes	An error occurred.

Remarks

The FwpsNetBufferListRemoveContext0 function asynchronously removes the tagged context associated with a network buffer list.

To associate a context with a network buffer list, call FwpsNetBufferListAssociateContext0 or FwpsNetBufferListAssociateContext1.

Usually a callout driver will not need to use this function, because the tagged context is removed automatically when the packets move through the stack. This function is provided so that a callout driver can stop processing in situations where contexts aren't removed automatically. For example, in the case of an NDIS filter driver, the packets never enter the TCP/IP stack, and the contexts will need to be removed manually by calling FwpsNetBufferListRemoveContext0 with the netBufferList parameter set to NULL.

Requirements

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