FwpmProviderContextGetByKey0 function

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.

Syntax


DWORD WINAPI FwpmProviderContextGetByKey0(
  _In_   HANDLE engineHandle,
  _In_   const GUID *key,
  _Out_  FWPM_PROVIDER_CONTEXT0 **providerContext
);

Parameters

engineHandle [in]

Type: HANDLE

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

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.

providerContext [out]

Type: FWPM_PROVIDER_CONTEXT0**

The provider context information.

Return value

Type: DWORD

Return code/valueDescription
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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

FwpmProviderContextAdd0
FWPM_PROVIDER_CONTEXT0

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.