Skip to content

Latest commit

 

History

History
140 lines (109 loc) · 4.53 KB

nf-fwpmu-fwpmprovidercontextcreateenumhandle0.md

File metadata and controls

140 lines (109 loc) · 4.53 KB
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.FwpmProviderContextCreateEnumHandle0
FwpmProviderContextCreateEnumHandle0 function (fwpmu.h)
Creates a handle used to enumerate a set of provider contexts.
FwpmProviderContextCreateEnumHandle0
FwpmProviderContextCreateEnumHandle0 function [Filtering]
fwp.fwpmprovidercontextcreateenumhandle0_func
fwpmu/FwpmProviderContextCreateEnumHandle0
fwp\fwpmprovidercontextcreateenumhandle0_func.htm
fwp
3b660e3a-fba6-4466-aa82-eb90c27ae004
12/05/2018
FwpmProviderContextCreateEnumHandle0, FwpmProviderContextCreateEnumHandle0 function [Filtering], fwp.fwpmprovidercontextcreateenumhandle0_func, fwpmu/FwpmProviderContextCreateEnumHandle0
fwpmu.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Fwpuclnt.lib
Fwpuclnt.dll
Windows
19H1
FwpmProviderContextCreateEnumHandle0
fwpmu/FwpmProviderContextCreateEnumHandle0
c++
APIRef
kbSyntax
DllExport
Fwpuclnt.dll
FwpmProviderContextCreateEnumHandle0

FwpmProviderContextCreateEnumHandle0 function

-description

The FwpmProviderContextCreateEnumHandle0 function creates a handle used to enumerate a set of provider contexts.

-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 enumTemplate [in, optional]

Type: const FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0*

Template to selectively restrict the enumeration.

-param enumHandle [out]

Type: HANDLE*

Handle for provider context enumeration.

-returns

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
The enumerator was created 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 enumTemplate is NULL, all provider contexts are returned.

The enumerator is not "live", meaning it does not reflect changes made to the system after the call to FwpmProviderContextCreateEnumHandle0 returns. If you need to ensure that the results are current, you must call FwpmProviderContextCreateEnumHandle0 and FwpmProviderContextEnum0 from within the same explicit transaction.

The caller must free the returned handle by a call to FwpmProviderContextDestroyEnumHandle0.

The caller needs FWPM_ACTRL_ENUM access to the provider contexts' containers and FWPM_ACTRL_READ access to the provider contexts. Only provider contexts to which the caller has FWPM_ACTRL_READ access will be returned. See Access Control for more information.

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

-see-also

FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0

FwpmProviderContextDestroyEnumHandle0