FwpmProviderContextGetByKey2 function (fwpmu.h)

Article
02/22/2024

The FwpmProviderContextGetByKey2 function retrieves a provider context.

Note FwpmProviderContextGetByKey2 is the specific implementation of FwpmProviderContextGetByKey used in Windows 8. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows 7, FwpmProviderContextGetByKey1 is available. For Windows Vista, FwpmProviderContextGetByKey0 is available.

Syntax

DWORD FwpmProviderContextGetByKey2(
  [in]  HANDLE                 engineHandle,
  [in]  const GUID             *key,
  [out] FWPM_PROVIDER_CONTEXT2 **providerContext
);

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] key

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 FwpmProviderContextAdd2 for this object.

[out] providerContext

Type: FWPM_PROVIDER_CONTEXT2**

The provider context information.

Return value

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.

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