FwpmCalloutDeleteById0 function

The FwpmCalloutDeleteById0 function deletes a callout from the filter engine.

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

Syntax


NTSTATUS NTAPI FwpmCalloutDeleteById0(
  _In_ HANDLE engineHandle,
  _In_ UINT32 id
);

Parameters

engineHandle [in]

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.

id [in]

The run-time identifier for the callout that is being deleted from the filter engine. This must be the run-time identifier that was returned when the callout driver called the FwpmCalloutAdd0 function to add the callout to the filter engine.

Return value

The FwpmCalloutDeleteById0 function returns one of the following NTSTATUS codes.

Return codeDescription
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 run-time identifier specified in the id parameter.

Other status codes

An error occurred.

 

Remarks

A callout driver calls the FwpmCalloutDeleteById0 function to delete a callout from the filter engine, using the run-time identifier 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.

Requirements

Target platform

Universal

Version

Available starting with Windows Vista.

Header

Fwpmk.h (include Fwpmk.h)

Library

Fwpkclnt.lib

IRQL

PASSIVE_LEVEL

See also

FwpmCalloutAdd0
FwpmCalloutDeleteByKey0
FwpmEngineOpen0

 

 

Send comments about this topic to Microsoft

Show: