Share via

IPsecSaContextDeleteById0 (Compact 2013)

  • Article

3/26/2014

This function deletes an IPsec security association (SA) context.

Syntax

DWORD IPsecSaContextDeleteById0(
  __in  HANDLE engineHandle,
  __in  UINT64 id
);

Parameters

  • engineHandle
    A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
  • 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

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 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 transaction. It will fail with FWP_E_TXN_IN_PROGRESS.

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

The caller needs DELETE access to the IPsec security association database. See WFP Access Right Identifiers for more information.

Requirements

Header

fwpmu.h

Library

fwpuclnt.dll

See Also

Reference

WFP IPsec Functions
WFP Access Right Identifiers

Other Resources

Windows Filtering Platform