Share via


FwpsCalloutUnregisterById0 (Compact 2013)

3/26/2014

This function unregisters a callout from the WFP Filter Engine.

Syntax

NTSTATUS NTAPI
  FwpsCalloutUnregisterById0(
    IN const UINT32  calloutId
    );

Parameters

  • calloutId
    The run-time identifier for the callout that is being unregistered from the filter engine. This must be the run-time identifier that was returned when the callout driver called the FwpsCalloutRegister0 function to register the callout with the filter engine.

Return Value

The FwpsCalloutUnregisterById0 function returns one of the following NTSTATUS codes:

Value

Description

STATUS_SUCCESS

The callback function was successfully registered by using the filter engine.

STATUS_DEVICE_BUSY

One or more data flows that have an outstanding associated context are being processed by the callout.

STATUS_FWP_CALLOUT_NOT_FOUND

No callout that matches the run-time identifier specified in the calloutId parameter is registered with the filter engine.

STATUS_FWP_IN_USE

The callout is already being registered or unregistered by another thread

Other status codes

An error occurred.

Remarks

A callout driver calls the FwpsCalloutUnregisterById0 function to unregister a callout from the filter engine, by using the run-time identifier to identify the callout to be unregistered. This function will succeed even if there are filters in the filter engine that specify the callout for the filter's action. In this case, filters with an action type of FWP_ACTION_CALLOUT_TERMINATING or FWP_ACTION_CALLOUT_UNKNOWN are treated as FWP_ACTION_BLOCK. Filters with an action type of FWP_ACTION_CALLOUT_INSPECTION are ignored after the callout has been unregistered from the filter engine.

A callout driver cannot be unloaded until all the callouts that were previously registered by using the filter engine are successfully unregistered.

Requirements

Header

fwpsk.h

See Also

Reference

Functions Called by Callout Drivers
FwpsCalloutRegister0
FwpsCalloutUnregisterByKey0
FwpsFlowRemoveContext0
WFP Callout Driver Functions