FwpmProviderGetByKey0 function

The FwpmProviderGetByKey0 function retrieves a provider.

Syntax


DWORD WINAPI FwpmProviderGetByKey0(
  _In_        HANDLE         engineHandle,
  _In_  const GUID           *key,
  _Out_       FWPM_PROVIDER0 **provider
);

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*

A runtime identifier for the desired object. This is the same GUID that was specified when the application called FwpmProviderAdd0.

provider [out]

Type: FWPM_PROVIDER0**

The provider information.

Return value

Type: DWORD

Return code/valueDescription
ERROR_SUCCESS
0

The provider 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. See Access Control for more information.

FwpmProviderGetByKey0 is a specific implementation of FwpmProviderGetByKey. See WFP Version-Independent Names and Targeting Specific Versions of Windows 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

FwpmProviderAdd0
FWPM_PROVIDER0

 

 

Show: