Skip to content

Latest commit

 

History

History
135 lines (107 loc) · 4.11 KB

nf-fwpmu-fwpmprovidercontextgetbykey0.md

File metadata and controls

135 lines (107 loc) · 4.11 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.FwpmProviderContextGetByKey0
FwpmProviderContextGetByKey0 function (fwpmu.h)
Retrieves a provider context. (FwpmProviderContextGetByKey0)
FwpmProviderContextGetByKey0
FwpmProviderContextGetByKey0 function [Filtering]
fwp.fwpmprovidercontextgetbykey0_func
fwpmu/FwpmProviderContextGetByKey0
fwp\fwpmprovidercontextgetbykey0_func.htm
fwp
09319701-4023-4517-ae25-a2c342cc9df2
12/05/2018
FwpmProviderContextGetByKey0, FwpmProviderContextGetByKey0 function [Filtering], fwp.fwpmprovidercontextgetbykey0_func, fwpmu/FwpmProviderContextGetByKey0
fwpmu.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Fwpuclnt.lib
Fwpuclnt.dll
Windows
19H1
FwpmProviderContextGetByKey0
fwpmu/FwpmProviderContextGetByKey0
c++
APIRef
kbSyntax
DllExport
Fwpuclnt.dll
FwpmProviderContextGetByKey0

FwpmProviderContextGetByKey0 function

-description

The FwpmProviderContextGetByKey0 function retrieves a provider context.

Note  FwpmProviderContextGetByKey0 is the specific implementation of FwpmProviderContextGetByKey used in Windows Vista. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows 7, FwpmProviderContextGetByKey1 is available. For Windows 8, FwpmProviderContextGetByKey2 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 key [in]

Type: const GUID*

Pointer to a GUID that uniquely identifies the provider context. This is a pointer to the same GUID that was specified when the application called FwpmProviderContextAdd0 for this object.

-param providerContext [out]

Type: FWPM_PROVIDER_CONTEXT0**

The provider context information.

-returns

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
The provider context was retrieved 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

The caller must free the returned object by a call to FwpmFreeMemory0.

The caller needs FWPM_ACTRL_READ access to the provider context. See Access Control for more information.

-see-also

FWPM_PROVIDER_CONTEXT0

FwpmProviderContextAdd0