FwpmBfeStateGet0 (Compact 2013)

3/26/2014

This function retrieves the current state of the WFP Filter Engine.

Syntax

FWPM_SERVICE_STATE NTAPI
  FwpmBfeStateGet0(
    );

Parameters

None

Return Value

The FwpmBfeStateGet0 function returns one of the following values:

Value	Description
FWPM_SERVICE_STOPPED	The filter engine is not running
FWPM_SERVICE_START_PENDING	The filter engine is starting
FWPM_SERVICE_STOP_PENDING	The filter engine is stopping
FWPM_SERVICE_RUNNING	The filter engine is running

Remarks

A callout driver calls the FwpmBfeStateGet0 function to retrieve the current state of the filter engine. A callout driver cannot open a session to the filter engine if the filter engine is currently not running.

If a callout driver must be notified of changes to the state of the filter engine, it can call the FwpmBfeStateSubscribeChanges0 function to register a callback function that is called whenever the state of the filter engine changes.

Requirements

Header

fwpmk.h

See Also

Reference

Functions Called by Callout Drivers
FwpmBfeStateSubscribeChanges0
WFP Callout Driver Functions