FwpmSubLayerDeleteByKey0 (Compact 2013)

  • Article

3/26/2014

This function deletes a sub-layer from the system by its key.

Syntax

DWORD WINAPI FwpmSubLayerDeleteByKey0(
  __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 sub-layer to be removed from the system. This must be a pointer to the same GUID that was specified when the application called the FwpmSubLayerAdd0 function to add the sub-layer to the filter engine.

Return Value

Return code / value

Description

ERROR_SUCCESS

0

The sub-layer 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

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

Requirements

Header

fwpmu.h

Library

fwpuclnt.dll

See Also

Reference

WFP Sub-Layer Management
WFP Access Right Identifiers
WFP Management Functions

Other Resources

Windows Filtering Platform