IPsecSaContextDeleteById0 function (fwpmk.h)

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

Syntax

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

Parameters

[in] engineHandle

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

[in] id

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

Remarks

This function cannot be called from within a transaction, it fails 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 fails 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

See also

Here are all the markdown links in the current document:

• FwpmEngineOpen0
• IPsecSaContextCreate0
• DELETE
• Access Control
• Object Management
• WFP Error Codes
• WFP Version-Independent Names and Targeting Specific Versions of Windows