FwpmFilterEnum0 - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// fwpmk.h
NTSTATUS FwpmFilterEnum0(
[in] HANDLE engineHandle,
[in] HANDLE enumHandle,
[in] UINT32 numEntriesRequested,
[out] FWPM_FILTER0 ***entries,
[out] UINT32 *numEntriesReturned
);
View the official Windows Driver Kit DDI referenceNo description available.
The FwpmFilterEnum0 function returns the next page of results from the filter enumerator.
engineHandle [in]Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
enumHandle [in]Handle of a filter enumeration created by a call to FwpmFilterCreateEnumHandle0.
numEntriesRequested [in]The number of filter objects requested.
entries [out]Addresses of enumeration entries.
numEntriesReturned [out]The number of filter objects returned.
| Return code/value | Description |
|---|---|
| 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. |
| Other NTSTATUS codes | An error occurred. |
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.