Share via

FwpmProviderContextEnum0 (Compact 2013)

  • Article

3/26/2014

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

Syntax

DWORD WINAPI FwpmProviderContextEnum0(
  __in   HANDLE engineHandle,
  __in   HANDLE enumHandle,
  __in   UINT32 numEntriesRequested,
  __out  FWPM_PROVIDER_CONTEXT0*** entries,
  __out  UINT32* numEntriesReturned
);

Parameters

  • engineHandle
    A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
  • numEntriesRequested
    Number of provider context objects requested.
  • numEntriesReturned
    Pointer to an UINT32 variable that will contain 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 topic 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.

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

Requirements

Header

fwpmu.h

Library

fwpuclnt.dll

See Also

Reference

WFP Provider Context Management
WFP Functions
WFP Management Functions
FwpmProviderContextAdd0
FwpmProviderContextCreateEnumHandle0
FwpmProviderContextDeleteById0
FwpmProviderContextDeleteByKey0
FwpmProviderContextDestroyEnumHandle0
FwpmProviderContextGetById0
FwpmProviderContextGetByKey0
FwpmProviderContextSubscribeChanges0

Other Resources

Windows Filtering Platform