FwpmConnectionEnum0 function

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

Syntax


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

numEntriesRequested [in]

Type: UINT32

Number of connection objects requested.

entries [out]

Type: FWPM_CONNECTION0***

Addresses of enumeration entries.

numEntriesReturned [out]

Type: UINT32*

Return value

Type: DWORD

Return code/valueDescription
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

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

FwpmConnectionCreateEnumHandle0
FWPM_CONNECTION0

 

 

Community Additions

ADD
Show:
© 2014 Microsoft