FwpmCalloutDeleteById0 function (fwpmu.h)

The FwpmCalloutDeleteById0 function removes a callout object from the system.

Syntax

DWORD FwpmCalloutDeleteById0(
  [in] HANDLE engineHandle,
  [in] UINT32 id
);

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] id

Type: UINT32

The runtime identifier for the callout being removed from the system. This identifier was received from the system when the application called FwpmCalloutAdd0 for this object.

Return value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
The callout 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

An applications's callouts cannot be removed from the system as long as there are filters in the system that specify the callouts for an action.

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 callout. See Access Control for more information.

FwpmCalloutDeleteById0 is a specific implementation of FwpmCalloutDeleteById. 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]
Target Platform Windows
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll

See also

FwpmCalloutAdd0

Kernel-Mode FwpmCalloutDeleteById0