FwpmFilterGetById0 function (fwpmu.h)
The FwpmFilterGetById0 function retrieves a filter object.
Syntax
DWORD FwpmFilterGetById0(
[in] HANDLE engineHandle,
[in] UINT64 id,
[out] FWPM_FILTER0 **filter
);
Parameters
[in] engineHandle
Type: HANDLE
Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
[in] id
Type: UINT64
A runtime identifier for the desired object. This identifier was received from the system when the application called FwpmFilterAdd0 for this object.
[out] filter
Type: FWPM_FILTER0**
The filter information.
Return value
Type: DWORD
| Return code/value | Description |
|---|---|
|
The filter was retrieved successfully. |
|
A Windows Filtering Platform (WFP) specific error. See WFP Error Codes for details. |
|
Failure to communicate with the remote or local firewall engine. |
Remarks
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.
FwpmFilterGetById0 is a specific implementation of FwpmFilterGetById. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.
Requirements
| Requirement | Value |
|---|---|
| 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 |