Edit

FwpsFlowAbort0 function (fwpsk.h)

  • Article

The FwpsFlowAbort0 function aborts a data flow.

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

 

Syntax

NTSTATUS FwpsFlowAbort0(
  [in] UINT64 flowId
);

Parameters

[in] flowId

A run-time identifier that specifies the data flow that is being aborted. The run-time identifier for a data flow is provided to a callout driver through the FWPS_METADATA_FIELD_FLOW_HANDLE metadata value that the filter engine provided to the callout driver's classifyFn callout function.

Return value

The FwpsFlowAbort0 function returns one of the following NTSTATUS codes.

Return code Description
STATUS_SUCCESS
 The flow was aborted.
Other status codes
 An error occurred.

Remarks

A callout driver can call the FwpsFlowAbort0 function to abort a data flow. The filter engine calls the flowDeleteFn callout function when the flow is terminated so that the callout driver can clean up the context associated with the flow.

Requirements

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

See also

classifyFn

flowDeleteFn