FwpmFilterDeleteById0 function

The FwpmFilterDeleteById0 function removes a filter object from the system.

Syntax


DWORD WINAPI FwpmFilterDeleteById0(
  _In_ HANDLE engineHandle,
  _In_ UINT64 id
);

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

Runtime identifier for the object being removed from the system. This value is returned by the FwpmFilterAdd0 function.

Return value

Type: DWORD

Return code/valueDescription
ERROR_SUCCESS
0

The filter was successfully deleted.

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

This function cannot be called from within a read-only transaction. It will fail with FWP_E_INCOMPATIBLE_TXN. See Object Management for more information about transactions.

This function can be called within a dynamic session if the corresponding object was added during the same session. If this function is called for an object that was added during a different dynamic session, it will fail with FWP_E_WRONG_SESSION. If this function is called for an object that was not added during a dynamic session, it will fail with FWP_E_DYNAMIC_SESSION_IN_PROGRESS.

The caller needs DELETE access to the filter. See Access Control for more information.

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

 

 

Show: