FwpsCalloutRegister1 function

The FwpsCalloutRegister1 function registers a callout with the filter engine.

Note FwpsCalloutRegister1 is the specific version of FwpsCalloutRegister used in Windows 7 and later. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows 8, FwpsCalloutRegister2 is available. For Windows Vista, FwpsCalloutRegister0 is available.

Syntax

NTSTATUS FwpsCalloutRegister1(
  void                *deviceObject,
  const FWPS_CALLOUT1 *callout,
  UINT32              *calloutId
);

Parameters

deviceObject

A pointer to a device object that was previously created by the callout driver. For more information about how a callout driver creates a device object, see Creating a Device Object.

callout

A pointer to a constant FWPS_CALLOUT1 structure that contains the data that is required to register the callout with the filter engine.

calloutId

A pointer to a UINT32-typed variable that receives a run-time identifier that identifies the callout in the filter engine. The callout driver passes this identifier to the FwpsCalloutUnregisterById0 function when unregistering the callout from the filter engine. If a callout driver is filtering a data flow, it also passes this identifier to the FwpsFlowAssociateContext0 and FwpsFlowRemoveContext0 functions. If a callout driver injects data into data streams, it also passes this identifier to the FwpsStreamInjectAsync0 function. The filter engine also passes this identifier to the callout driver's flowDeleteFn callout function. This parameter is optional and can be NULL.

Return Value

The FwpsCalloutRegister1 function returns one of the following NTSTATUS codes.

Return code Description
STATUS_SUCCESS
The callout was successfully registered with the filter engine.
STATUS_FWP_ALREADY_EXISTS
The callout could not be registered with the filter engine. A callout is already registered in the filter engine with an identifier identical to the GUID specified in the calloutKey member of the FWPS_CALLOUT1 structure pointed to by the callout parameter.
Other status codes
An error occurred.

Remarks

A callout driver calls the FwpsCalloutRegister1 function to register a callout with the filter engine. A callout driver can register a callout with the filter engine at any time, even if the filter engine is not currently running.

A callout and filters that specify the callout for the filter's action can be added to the filter engine before a callout driver registers the callout with the filter engine. In this situation, filters with an action type of FWP_ACTION_CALLOUT_TERMINATING or FWP_ACTION_CALLOUT_UNKNOWN are treated as FWP_ACTION_BLOCK, and filters with an action type of FWP_ACTION_CALLOUT_INSPECTION are ignored until the callout is registered with the filter engine.

A callout driver unregisters a callout from the filter engine by calling either the FwpsCalloutUnregisterById0 function or the FwpsCalloutUnregisterByKey0 function. A callout driver cannot be unloaded until all of the callouts that were previously registered with the filter engine have been successfully unregistered.

Requirements

   
Windows version Available starting with Windows 7.
Target Platform Universal
Header fwpsk.h (include Fwpsk.h)
Library Fwpkclnt.lib
IRQL PASSIVE_LEVEL

See Also

FWPS_CALLOUT1

FwpsCalloutRegister0

FwpsCalloutRegister2

FwpsCalloutUnregisterById0

FwpsCalloutUnregisterByKey0

FwpsFlowAssociateContext0

FwpsFlowRemoveContext0

FwpsStreamInjectAsync0

IoCreateDevice

Types of Callouts

flowDeleteFn