FwpmLayerEnum0 function (fwpmu.h)

  • Article

The FwpmLayerEnum0 function returns the next page of results from the layer enumerator.

Syntax

DWORD FwpmLayerEnum0(
  [in]  HANDLE      engineHandle,
  [in]  HANDLE      enumHandle,
  [in]  UINT32      numEntriesRequested,
  [out] FWPM_LAYER0 ***entries,
  [out] UINT32      *numEntriesReturned
);

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] enumHandle

Type: HANDLE

Handle for a layer enumeration created by a call to FwpmLayerCreateEnumHandle0.

[in] numEntriesRequested

Type: UINT32

The number of layer entries requested.

[out] entries

Type: FWPM_LAYER0***

Addresses of the enumeration entries.

[out] numEntriesReturned

Type: UINT32*

The number of layer entries returned.

Return value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
 The layers 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.

Remarks

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.

FwpmLayerEnum0 is a specific implementation of FwpmLayerEnum. 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

See also

FWPM_LAYER0

FwpmLayerCreateEnumHandle0