Edit

Share via

FwpmProviderContextEnum2 function (fwpmu.h)

  • Article

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

Note  FwpmProviderContextEnum2 is the specific implementation of FwpmProviderContextEnum used in Windows 8. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows 7, FwpmProviderContextEnum1 is available. For Windows Vista, FwpmProviderContextEnum0 is available.
 

Syntax

DWORD FwpmProviderContextEnum2(
  [in]  HANDLE                 engineHandle,
  [in]  HANDLE                 enumHandle,
  [in]  UINT32                 numEntriesRequested,
  [out] FWPM_PROVIDER_CONTEXT2 ***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 FwpmProviderContextCreateEnumHandle0.

[in] numEntriesRequested

Type: UINT32

Number of provider context objects requested.

[out] entries

Type: FWPM_PROVIDER_CONTEXT2***

The returned provider context objects.

[out] numEntriesReturned

Type: 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. 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.

FwpmProviderContextEnum2 works on a snapshot of the provider contexts 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_PROVIDER_CONTEXT2