Edit

Share via

FwpmConnectionEnum0 function (fwpmu.h)

  • Article

The FwpmConnectionEnum0 function returns the next page of results from the connection object enumerator.

Syntax

DWORD FwpmConnectionEnum0(
  [in]  HANDLE           engineHandle,
  [in]  HANDLE           enumHandle,
  [in]  UINT32           numEntriesRequested,
  [out] FWPM_CONNECTION0 ***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 provider context enumeration created by a call to FwpmConnectionCreateEnumHandle0.

[in] numEntriesRequested

Type: UINT32

Number of connection objects requested.

[out] entries

Type: FWPM_CONNECTION0***

Addresses of enumeration entries.

[out] numEntriesReturned

Type: UINT32*

Return value

Type: DWORD

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

FwpmConnectionEnum0 works on a snapshot of the connection objects taken at the time the enumeration handle was created.

Requirements

Requirement Value
Minimum supported client Windows 8 [desktop apps only]
Minimum supported server Windows Server 2012 [desktop apps only]
Target Platform Windows
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll

See also

FWPM_CONNECTION0

FwpmConnectionCreateEnumHandle0