Edit

Share via

FwpmSubLayerDeleteByKey0 function (fwpmk.h)

  • Article

The FwpmSubLayerDeleteByKey0 function deletes a sublayer from the system by its key.

Syntax

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

Parameters

[in] engineHandle

Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

[in] key

Unique identifier of the sublayer to be removed from the system. This is the same GUID that was specified when the application called FwpmSubLayerAdd0.

Return value

Return code/value Description
ERROR_SUCCESS
0		 The sublayer 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.
Other NTSTATUS codes An error occurred.

Remarks

This function cannot be called from within a read-only transaction, it fails 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 fails with FWP_E_WRONG_SESSION. If this function is called for an object that was not added during a dynamic session, it fails with FWP_E_DYNAMIC_SESSION_IN_PROGRESS.

The caller needs DELETE access to the sub-layer. See Access Control for more information.

FwpmSubLayerDeleteByKey0 is a specific implementation of FwpmSubLayerDeleteByKey. 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
Library fwpkclnt.lib
IRQL <= PASSIVE_LEVEL

See also