FwpmFilterCreateEnumHandle0 (Compact 2013)
3/26/2014
This function creates a handle used to enumerate a set of filter objects.
Syntax
DWORD WINAPI FwpmFilterCreateEnumHandle0(
__in HANDLE engineHandle,
__in_opt const FWPM_FILTER_ENUM_TEMPLATE0* enumTemplate,
__out HANDLE* enumHandle
);
Parameters
- engineHandle
A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
- enumTemplate
Address of an FWPM_FILTER_ENUM_TEMPLATE0 structure used to selectively restrict the enumeration.
- enumHandle
Address of a HANDLE variable. On function return, it contains the handle for filter enumeration.
Return Value
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 topic 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 WFP Access Right Identifiers for more information.
Requirements
Header |
fwpmu.h |
Library |
fwpuclnt.dll |
See Also
Reference
WFP Filter Management
WFP Access Right Identifiers