FwpmFilterGetById0 function

The FwpmFilterGetById0 function retrieves a filter object.

Syntax


DWORD WINAPI FwpmFilterGetById0(
  _In_   HANDLE engineHandle,
  _In_   UINT64 id,
  _Out_  FWPM_FILTER0 **filter
);

Parameters

engineHandle [in]

Type: HANDLE

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

id [in]

Type: UINT64

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

filter [out]

Type: FWPM_FILTER0**

The filter information.

Return value

Type: DWORD

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

FwpmFilterGetById0 is a specific implementation of FwpmFilterGetById. 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

FwpmFilterAdd0
FWPM_FILTER0
FwpmFilterDeleteById0

 

 

Community Additions

ADD
Show:
© 2014 Microsoft