FwpmFilterCreateEnumHandle0 function

The FwpmFilterCreateEnumHandle0 function creates a handle used to enumerate a set of filter objects.

Syntax

DWORD FwpmFilterCreateEnumHandle0(
  HANDLE                           engineHandle,
  const FWPM_FILTER_ENUM_TEMPLATE0 *enumTemplate,
  HANDLE                           *enumHandle
);

Parameters

engineHandle

Type: HANDLE

Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

enumTemplate

Type: const FWPM_FILTER_ENUM_TEMPLATE0*

Template to selectively restrict the enumeration.

enumHandle

Type: HANDLE*

The handle for filter enumeration.

Return Value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
The enumerator was created successfully.
FWP_E_* error code
0x80320001—0x80320039
A Windows Filtering Platform (WFP) specific error. See WFP Error Codes for details.
RPC_* error code
0x80010001—0x80010122
Failure to communicate with the remote or local firewall engine.

Remarks

If enumTemplate is NULL, all filters are returned.

The enumerator is not "live", meaning it does not reflect changes made to the system after the call to FwpmFilterCreateEnumHandle0 returns. If you need to ensure that the results are current, you must call FwpmFilterCreateEnumHandle0 and FwpmFilterEnum0 from within the same explicit transaction.

The caller must free the returned handle by a call to FwpmFilterDestroyEnumHandle0.

The caller needs FWPM_ACTRL_ENUM access to the filters' containers and FWPM_ACTRL_READ access to the filters. Only filters to which the caller has FWPM_ACTRL_READ access will be returned. See Access Control for more information.

FwpmFilterCreateEnumHandle0 is a specific implementation of FwpmFilterCreateEnumHandle. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll

See Also

FWPM_FILTER_ENUM_TEMPLATE0

FwpmFilterDestroyEnumHandle0