Share via

FwpmCalloutDeleteByKey0 (Compact 2013)

  • Article

3/26/2014

This function removes a callout object from the system.

Syntax

DWORD WINAPI FwpmCalloutDeleteByKey0(
  __in  HANDLE engineHandle,
  __in  const GUID* key
);

Parameters

  • engineHandle
    A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
  • key
    A pointer to a GUID that uniquely identifies the callout being removed from the system. This GUID was specified in the calloutKey member of the callout parameter when the application called FwpmCalloutAdd0 for this object.

Return Value

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 topic WFP Error Codes for details.

RPC_* error code

0x80010001-0x80010122

Failure to communicate with the remote or local firewall engine

Remarks

An application'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.

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

Requirements

Header

fwpmu.h

Library

fwpuclnt.dll

See Also

Reference

WFP Callout Management
WFP Management Functions
WFP Access Right Identifiers

Other Resources

Windows Filtering Platform