FwpsFlowRemoveContext0 (Compact 2013)

3/26/2014

This function removes a previously associated context from a data flow.

Syntax

NTSTATUS NTAPI
  FwpsFlowRemoveContext0(
    IN UINT64  flowId,
    IN UINT16  layerId,
    IN UINT32  calloutId
    );

Parameters

• lowId
  A run-time identifier that specifies the data flow from which to remove a context. The run-time identifier for a data flow is provided to a callout driver through the FWPS_METADATA_FIELD_FLOW_HANDLE metadata value that was passed to the callout's classifyFn callout function.

• layerId
  The run-time identifier for the filtering layer from which the context is being removed. A callout driver should specify the same identifier as when it called the FwpsFlowAssociateContext0 function to associate the context with the data flow.

• calloutId
  The run-time identifier for the callout in the filter engine. This identifier was returned when the callout driver called the FwpsCalloutRegister0 function to register the callout with the WFP Filter Engine.

Return Value

The FwpsFlowRemoveContext0 function returns one of the following NTSTATUS codes:

Value	Description
STATUS_SUCCESS	The context was successfully removed from the data flow.
STATUS_PENDING	An active callout classification is in progress. FwpsFlowRemoveContext0 will call the flowDeleteFn callout function asynchronously.
STATUS_UNSUCCESSFUL	No context is currently associated with the data flow.
Other status codes	An error occurred.

Remarks

If the FwpsFlowRemoveContext0 function returns STATUS_SUCCESS, FwpsFlowRemoveContext0 calls the flowDeleteFn callout function synchronously. If FwpsFlowRemoveContext0 returns STATUS_PENDING, FwpsFlowRemoveContext0 calls flowDeleteFn asynchronously because an active callout classification is in progress.

Requirements

Header

fwpsk.h

See Also

Reference

Functions Called by Callout Drivers
classifyFn
FwpsCalloutRegister0
FwpsFlowAssociateContext0
flowDeleteFn
WFP Callout Driver Run-time Filtering Layer Identifiers
WFP Callout Driver Functions