FwpmProviderContextEnum3 function (fwpmu.h)

  • Article

Returns the next page of results from the provider context enumerator.

Syntax

DWORD FwpmProviderContextEnum3(
  HANDLE                 engineHandle,
  HANDLE                 enumHandle,
  UINT32                 numEntriesRequested,
  FWPM_PROVIDER_CONTEXT3 ***entries,
  UINT32                 *numEntriesReturned
);

Parameters

engineHandle

Type: _In_ HANDLE

A handle to an open session with the filter engine. To open a session with the filter engine, call FwpmEngineOpen0.

enumHandle

Type: _In_ HANDLE

A handle to a network event enumeration created by a call to FwpmProviderContextCreateEnumHandle0.

numEntriesRequested

Type: _In_ UINT32

Number of provider context objects requested.

entries

Type: _Outptr_result_buffer_(*numEntriesReturned) FWPM_PROVIDER_CONTEXT3***

The returned provider context objects.

numEntriesReturned

Type: _Out_ UINT32*

The number of provider context objects returned.

Return value

Type: DWORD*

Return code/value Description
ERROR_SUCCESS
0		 The provider contexts were enumerated successfully.
FWP_E_* error code
0x80320001—0x80320039		 A Windows Filtering Platform (WFP)-specific error. For details, see WFP error codes.
RPC_* error code
0x80010001—0x80010122		 Failure to communicate with the remote or local firewall engine.

Remarks

If numEntriesReturned is less than the numEntriesRequested, then the enumeration is exhausted.

You must free the returned array of entries (but not the individual entries themselves) by calling FwpmFreeMemory0.

A subsequent call that uses the same enumHandle parameter will return the next set of events following those in the last output buffer.

FwpmProviderContextEnum3 works on a snapshot of the provider contexts taken at the time the enumeration handle was created.

Requirements

Requirement Value
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll