Edit

Share via

FwpmCalloutDeleteByKey0 function (fwpmk.h)

  • Article

The FwpmCalloutDeleteByKey0 function deletes a callout from the filter engine.

Syntax

NTSTATUS FwpmCalloutDeleteByKey0(
  [in] HANDLE     engineHandle,
  [in] const GUID *key
);

Parameters

[in] engineHandle

A handle for an open session to the filter engine. A "callout" driver calls the FwpmEngineOpen0 function to open a session to the filter engine.

[in] key

A pointer to a GUID that uniquely identifies the callout that is being deleted from the filter engine. This must be a pointer to the same GUID that was specified when the callout driver called the FwpmCalloutAdd0 function to add the callout to the filter engine.

Return value

The FwpmCalloutDeleteByKey0 function returns one of the following NTSTATUS codes.

Return code Description
STATUS_SUCCESS The callout was successfully deleted from the filter engine.
STATUS_FWP_IN_USE One or more filters in the filter engine specify the callout for the filter's action.
STATUS_FWP_CALLOUT_NOT_FOUND There is not a callout in the filter engine that matches the GUID specified in the key parameter.
Other NTSTATUS codes An error occurred.

Remarks

A callout driver calls the FwpmCalloutDeleteByKey0 function to delete a callout from the filter engine, using the GUID key to identify the callout to be deleted.

Callout drivers do not typically delete their callouts from the filter engine. In most situations, this is handled by a user-mode Windows Filtering Platform management application.

A callout can be deleted from the filter engine only if there are no filters in the filter engine that specify the callout for the filter's action.

FwpmCalloutDeleteByKey0 is a specific version of FwpmCalloutDeleteByKey. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Requirements

Requirement Value
Minimum supported client Available starting with Windows Vista.
Target Platform Universal
Header fwpmk.h (include Fwpmk.h)
Library Fwpkclnt.lib
IRQL PASSIVE_LEVEL

See also