FwpmFilterGetByKey0 function (fwpmu.h)

  • Article

The FwpmFilterGetByKey0 function retrieves a filter object.

Syntax

DWORD FwpmFilterGetByKey0(
  [in]  HANDLE       engineHandle,
  [in]  const GUID   *key,
  [out] FWPM_FILTER0 **filter
);

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*

Unique identifier of the filter. This GUID was specified in the filterKey member of the filter parameter when the application called FwpmFilterAdd0 for this object.

[out] filter

Type: FWPM_FILTER0**

The filter information.

Return value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
 The filter 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 filter. See Access Control for more information.

FwpmFilterGetByKey0 is a specific implementation of FwpmFilterGetByKey. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll

See also

FWPM_FILTER0

FwpmFilterAdd0

FwpmFilterDeleteByKey0