FwpmFilterGetById0 (Compact 2013)

3/26/2014

This function retrieves a filter object.

Syntax

DWORD WINAPI FwpmFilterGetById0(
  __in   HANDLE engineHandle,
  __in   UINT64 id,
  __out  FWPM_FILTER0** filter
);

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

id
A runtime identifier for the desired object. This identifier was received from the system when the application called FwpmFilterAdd0 for this object.

filter
Pointer to the address of a FWPM_FILTER0 structure containing the filter information.

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 topic WFP Error Codes for details.
RPC_* error code 0x80010001-0x80010122	Failure to communicate with the remote or local firewall engine

ERROR_SUCCESS

The filter 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 filter. See WFP Access Right Identifiers for more information.

Header	fwpmu.h
Library	fwpuclnt.dll