FwpmBfeStateGet0 function (fwpmk.h)

The FwpmBfeStateGet0 function retrieves the current state of the filter engine.

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

 

Syntax

FWPM_SERVICE_STATE FwpmBfeStateGet0();

Return value

The FwpmBfeStateGet0 function returns one of the following values.

Return code	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. For a callout driver to open a session to the filter engine, the filter engine must be currently running.

Before calling FwpmBfeStateGet0, the callout driver must call the FwpmBfeStateSubscribeChanges0 function to register a callback function that is called whenever the state of the filter engine changes.

Requirements

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

See also

FwpmBfeStateSubscribeChanges0