FwpmSubLayerEnum0 function (fwpmu.h)

The FwpmSubLayerEnum0 function returns the next page of results from the sublayer enumerator.

Syntax

DWORD FwpmSubLayerEnum0(
  [in]  HANDLE         engineHandle,
  [in]  HANDLE         enumHandle,
  [in]  UINT32         numEntriesRequested,
  [out] FWPM_SUBLAYER0 ***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 sublayer enumeration created by a call to FwpmSubLayerCreateEnumHandle0.

[in] numEntriesRequested

Type: UINT32

The number of sublayer entries requested.

[out] entries

Type: FWPM_SUBLAYER0***

Addresses of the enumeration entries.

[out] numEntriesReturned

Type: UINT32*

The number of sublayer objects returned.

Return value

Type: DWORD

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.

FwpmSubLayerEnum0 works on a snapshot of the sublayers taken at the time the enumeration handle was created.

FwpmSubLayerEnum0 is a specific implementation of FwpmSubLayerEnum. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Requirements

See also

FWPM_SUBLAYER0

FwpmSubLayerCreateEnumHandle0