Edit

IPsecSaContextDeleteById0 function (fwpmu.h)

  • Article

The IPsecSaContextDeleteById0 function deletes an IPsec security association (SA) context.

Syntax

DWORD IPsecSaContextDeleteById0(
  [in] HANDLE engineHandle,
  [in] UINT64 id
);

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] id

Type: UINT64

A runtime identifier for the object being removed from the system. This identifier was received from the system when the application called IPsecSaContextCreate0.

Return value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
 The IPsec SA context 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 transaction. It will fail with FWP_E_TXN_IN_PROGRESS. See Object Management for more information about transactions.

This function cannot be called from within a dynamic session. The call will fail with FWP_E_DYNAMIC_SESSION_IN_PROGRESS. See Object Management for more information about dynamic sessions.

The caller needs DELETE access to the IPsec security associations database. See Access Control for more information.

IPsecSaContextDeleteById0 is a specific implementation of IPsecSaContextDeleteById. 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

IPsecSaContextCreate0