FwpmLayerCreateEnumHandle0 function (fwpmu.h)
The FwpmLayerCreateEnumHandle0 function creates a handle used to enumerate a set of layer objects.
Syntax
DWORD FwpmLayerCreateEnumHandle0(
[in] HANDLE engineHandle,
[in, optional] const FWPM_LAYER_ENUM_TEMPLATE0 *enumTemplate,
[out] HANDLE *enumHandle
);
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, optional] enumTemplate
Type: FWPM_LAYER_ENUM_TEMPLATE0*
Template to selectively restrict the enumeration.
[out] enumHandle
Type: HANDLE*
Handle for the layer enumeration.
Return value
Type: DWORD
| Return code/value | Description |
|---|---|
|
The enumerator was created 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
If enumTemplate is NULL, all layers are returned.
The enumerator is not "live", meaning it does not reflect changes made to the system after the call to FwpmLayerCreateEnumHandle0 returns. If you need to ensure that the results are current, you must call FwpmLayerCreateEnumHandle0 and FwpmLayerEnum0 from within the same explicit transaction.
The caller must free the returned handle by a call to the FwpmLayerDestroyEnumHandle0.
The caller needs FWPM_ACTRL_ENUM access to the layers' containers and FWPM_ACTRL_READ access to the layers. Only layers to which the caller has FWPM_ACTRL_READ access will be returned. See Access Control for more information.
FwpmLayerCreateEnumHandle0 is a specific implementation of FwpmLayerCreateEnumHandle. 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 |