FwpsNetBufferListRetrieveContext0 function

The FwpsNetBufferListRetrieveContext0 function retrieves the context associated with a network buffer list that was tagged in another layer.

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

Syntax


NTSTATUS NTAPI FwpsNetBufferListRetrieveContext0(
  _Inout_ NET_BUFFER_LIST *netBufferList,
  _In_    UINT64          contextTag,
  _In_    BOOLEAN         removeContext,
  _In_    UINT32          flags,
  _Out_   UINT64          *context
);

Parameters

netBufferList [in, out]

A network buffer list that indicates one or more packets of interest to the callout driver. If removeContext is set, the network buffer list returned will have the context removed.

contextTag [in]

A locally unique identifier obtained by calling the FwpsNetBufferListGetTagForContext0 function. This is the context tag used in the initial call to FwpsNetBufferListAssociateContext0.

removeContext [in]

If set, FwpsNetBufferListRetrieveContext0 will remove the context association in addition to retrieving the context.

flags [in]

This parameter is reserved for future use and is set to zero.

context [out]

The context assigned to the packet by the callout driver in the initial call to FwpsNetBufferListAssociateContext0.

Return value

The FwpsNetBufferListRetrieveContext0 function returns one of the following NTSTATUS codes.

Return codeDescription
STATUS_SUCCESS

The association was successful.

Other status codes

An error occurred.

 

Remarks

The FwpsNetBufferListRetrieveContext0 function retrieves a network buffer list that was tagged in another layer.

You can also use this function to remove the context association by setting the removeContext parameter.

Requirements

Target platform

Universal

Version

Available starting with Windows 7.

Header

Fwpsk.h (include Fwpsk.h)

Library

Fwpkclnt.lib

IRQL

<= DISPATCH_LEVEL

See also

NET_BUFFER_LIST
FwpsNetBufferListAssociateContext0
FwpsNetBufferListGetTagForContext0
FwpsNetBufferListRemoveContext0

 

 

Send comments about this topic to Microsoft

Show: