IPsecSaContextSetSpi0 function (fwpmu.h)

12/05/2018
2 minutes to read

The IPsecSaContextSetSpi0 function sets the security parameters index (SPI) for a security association (SA) context.

Syntax

DWORD IPsecSaContextSetSpi0(
  HANDLE              engineHandle,
  UINT64              id,
  const IPSEC_GETSPI1 *getSpi,
  IPSEC_SA_SPI        inboundSpi
);

Parameters

engineHandle

Type: HANDLE

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

id

Type: UINT64

A runtime identifier for the SA context. This identifier was received from the system when the application called IPsecSaContextCreate1.

getSpi

Type: IPSEC_GETSPI1*

The inbound IPsec traffic.

inboundSpi

Type: IPSEC_SA_SPI

The inbound SA SPI. The IPSEC_SA_SPI data type maps to the UINT32 data type.

Return value

Type: DWORD

Return code/value	Description
ERROR_SUCCESS 0	The SPI for the IPsec SA context was set successfully.
*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

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

IPsecSaContextSetSpi0 is a specific implementation of IPsecSaContextSetSpi. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Requirements


Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	fwpmu.h
Library	Fwpuclnt.lib
DLL	Fwpuclnt.dll