FwpmFilterGetByKey0 - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// fwpmk.h
NTSTATUS FwpmFilterGetByKey0(
[in] HANDLE engineHandle,
[in] const GUID *key,
[out] FWPM_FILTER0 **filter
);
View the official Windows Driver Kit DDI referenceNo description available.
The FwpmFilterGetByKey0 function retrieves a filter object.
engineHandle [in]Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
key [in]Unique identifier of the filter. This GUID was specified in the filterKey member of the filter parameter when the application called FwpmFilterAdd0 for this object.
filter [out]The filter information.
| Return code/value | Description |
|---|---|
| ERROR_SUCCESS 0 |
The filter was retrieved 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. |
The caller must free the returned object by a call to FwpmFreeMemory0.
The caller needs FWPM_ACTRL_READ access to the filter. See Access Control for more information.
FwpmFilterGetByKey0 is a specific implementation of FwpmFilterGetByKey. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.