Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

FwpmSubLayerEnum0 function

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

Syntax


DWORD WINAPI FwpmSubLayerEnum0(
  _In_   HANDLE engineHandle,
  _In_   HANDLE enumHandle,
  _In_   UINT32 numEntriesRequested,
  _Out_  FWPM_SUBLAYER0 ***entries,
  _Out_  UINT32 *numEntriesReturned
);

Parameters

engineHandle [in]

Type: HANDLE

Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

enumHandle [in]

Type: HANDLE

Handle for a sublayer enumeration created by a call to FwpmSubLayerCreateEnumHandle0.

numEntriesRequested [in]

Type: UINT32

The number of sublayer entries requested.

entries [out]

Type: FWPM_SUBLAYER0***

Addresses of the enumeration entries.

numEntriesReturned [out]

Type: UINT32*

The number of sublayer objects returned.

Return value

Type: DWORD

Return code/valueDescription
ERROR_SUCCESS
0

The sublayers 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.

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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

FwpmSubLayerCreateEnumHandle0
FWPM_SUBLAYER0

 

 

Community Additions

Show:
© 2014 Microsoft