Skip to content

Latest commit

 

History

History
151 lines (115 loc) · 4.46 KB

nf-fwpmu-fwpmprovidercontextenum1.md

File metadata and controls

151 lines (115 loc) · 4.46 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:fwpmu.FwpmProviderContextEnum1
FwpmProviderContextEnum1 function (fwpmu.h)
Returns the next page of results from the provider context enumerator. (FwpmProviderContextEnum1)
FwpmProviderContextEnum1
FwpmProviderContextEnum1 function [Filtering]
fwp.fwpmprovidercontextenum1_func
fwpmu/FwpmProviderContextEnum1
fwp\fwpmprovidercontextenum1_func.htm
fwp
97a6e562-0423-438d-ab21-48c0f0830610
12/05/2018
FwpmProviderContextEnum1, FwpmProviderContextEnum1 function [Filtering], fwp.fwpmprovidercontextenum1_func, fwpmu/FwpmProviderContextEnum1
fwpmu.h
Windows
Windows 7 [desktop apps only]
Windows Server 2008 R2 [desktop apps only]
Fwpuclnt.lib
Fwpuclnt.dll
Windows
19H1
FwpmProviderContextEnum1
fwpmu/FwpmProviderContextEnum1
c++
APIRef
kbSyntax
DllExport
Fwpuclnt.dll
FwpmProviderContextEnum1

FwpmProviderContextEnum1 function

-description

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

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

-parameters

-param engineHandle [in]

Type: HANDLE

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

-param enumHandle [in]

Type: HANDLE

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

-param numEntriesRequested [in]

Type: UINT32

The number of provider context objects requested.

-param entries [out]

Type: FWPM_PROVIDER_CONTEXT1***

The returned provider context objects.

-param numEntriesReturned [out]

Type: UINT32*

The number of provider context objects returned.

-returns

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.

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

-see-also

FWPM_PROVIDER_CONTEXT1

FwpmProviderContextCreateEnumHandle0