FwpmProviderContextEnum2 function (fwpmk.h)

  • Article

The FwpmProviderContextEnum2 function returns the next page of results from the provider context enumerator.

Syntax

NTSTATUS FwpmProviderContextEnum2(
  [in]  HANDLE                 engineHandle,
  [in]  HANDLE                 enumHandle,
  [in]  UINT32                 numEntriesRequested,
  [out] FWPM_PROVIDER_CONTEXT2 ***entries,
  [out] UINT32                 *numEntriesReturned
);

Parameters

[in] engineHandle

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

[in] enumHandle

Handle for a provider context enumeration created by a call to FwpmProviderContextCreateEnumHandle0.

[in] numEntriesRequested

The number of provider context objects requested.

[out] entries

The returned provider context objects.

[out] numEntriesReturned

The number of provider context objects returned.

Return value

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. See WFP Error Codes for details.
RPC_* error code
0x80010001—0x80010122		 Failure to communicate with the remote or local firewall engine.
Other NTSTATUS codes An error occurred.

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.

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

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

Requirements

Requirement Value
Minimum supported client Available starting with Windows Vista.
Target Platform Universal
Header fwpmk.h
Library fwpkclnt.lib
IRQL <= PASSIVE_LEVEL

See also