FwpmSubLayerDeleteByKey0 function (fwpmu.h)
The FwpmSubLayerDeleteByKey0 function deletes a sublayer from the system by its key.
Syntax
DWORD FwpmSubLayerDeleteByKey0(
[in] HANDLE engineHandle,
[in] const GUID *key
);
Parameters
[in] engineHandle
Type: HANDLE
Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
[in] key
Type: const GUID*
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
Type: DWORD
| Return code/value | Description |
|---|---|
|
The sublayer was successfully deleted. |
|
A Windows Filtering Platform (WFP) specific error. See WFP Error Codes for details. |
|
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. 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 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 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 | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Target Platform | Windows |
| Header | fwpmu.h |
| Library | Fwpuclnt.lib |
| DLL | Fwpuclnt.dll |