FwpmIPsecTunnelDeleteByKey0 function (fwpmu.h)

  • Article

The FwpmIPsecTunnelDeleteByKey0 function removes an Internet Protocol Security (IPsec) tunnel mode policy from the system.

Syntax

DWORD FwpmIPsecTunnelDeleteByKey0(
  [in] HANDLE     engineHandle,
  [in] const GUID *key
);

Parameters

[in] engineHandle

Type: HANDLE

A 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 IPsec tunnel. This GUID was specified in the providerContextKey member of the tunnelPolicy parameter of the FwpmIPsecTunnelAdd0 function.

Return value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
 The IPsec tunnel mode policy 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.

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.

FwpmIPsecTunnelDeleteByKey0 is a specific implementation of FwpmIPsecTunnelDeleteByKey. 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

See also

FwpmIPsecTunnelAdd0