FwpmFilterEnum0 function

The FwpmFilterEnum0 function returns the next page of results from the filter enumerator.

Syntax


DWORD WINAPI FwpmFilterEnum0(
  _In_   HANDLE engineHandle,
  _In_   HANDLE enumHandle,
  _In_   UINT32 numEntriesRequested,
  _Out_  FWPM_FILTER0 ***entries,
  _Out_  UINT32 *numEntriesReturned
);

Parameters

engineHandle [in]

Type: HANDLE

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

enumHandle [in]

Type: HANDLE

Handle for a filter enumeration created by a call to FwpmFilterCreateEnumHandle0.

numEntriesRequested [in]

Type: UINT32

The number of filter objects requested.

entries [out]

Type: FWPM_FILTER0***

Addresses of enumeration entries.

numEntriesReturned [out]

Type: UINT32*

The number of filter objects returned.

Return value

Type: DWORD

Return code/valueDescription
ERROR_SUCCESS
0

The filters were enumerated 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 the numEntriesReturned is less than the numEntriesRequested, the enumeration is exhausted.

The returned array of entries (but not the individual entries themselves) must be freed by a call to FwpmFreeMemory0.

A subsequent call using the same enumeration handle will return the next set of items following those in the last output buffer.

FwpmFilterEnum0 works on a snapshot of the filters taken at the time the enumeration handle was created.

FwpmFilterEnum0 is a specific implementation of FwpmFilterEnum. 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]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

FwpmFilterCreateEnumHandle0
FWPM_FILTER0

 

 

Community Additions

ADD
Show:
© 2015 Microsoft