FwpmProviderGetByKey0 (Compact 2013)

3/26/2014

This function retrieves a provider.

Syntax

DWORD WINAPI FwpmProviderGetByKey0(
  __in   HANDLE engineHandle,
  __in   const GUID* key,
  __out  FWPM_PROVIDER0** provider
);

engineHandle
A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

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

provider
Pointer to the address of a FWPM_PROVIDER0 structure containing the provider information.

Return code / value	Description
ERROR_SUCCESS 0	The provider was retrieved successfully
FWP_E_* error code 0x80320001-0x80320039	A Windows Filtering Platform (WFP) specific error. See topic WFP Error Codes for details.
RPC_* error code 0x80010001-0x80010122	Failure to communicate with the remote or local firewall engine

ERROR_SUCCESS

The provider was retrieved successfully

FWP_E_* error code

0x80320001-0x80320039

A Windows Filtering Platform (WFP) specific error. See topic WFP Error Codes for details.

RPC_* error code

0x80010001-0x80010122

Failure to communicate with the remote or local firewall engine

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

The caller needs FWPM_ACTRL_READ access to the provider. See WFP Access Right Identifiers for more information.

Header	fwpmu.h
Library	fwpuclnt.dll