IPsecSaContextGetSpi1 function (fwpmu.h)

Article
02/22/2024

The IPsecSaContextGetSpi1 function retrieves the security parameters index (SPI) for a security association (SA) context.

Note IPsecSaContextGetSpi1 is the specific implementation of IPsecSaContextGetSpi used in Windows 7 and later. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows Vista, IPsecSaContextGetSpi0 is available.

Syntax

DWORD IPsecSaContextGetSpi1(
  [in]  HANDLE              engineHandle,
  [in]  UINT64              id,
  [in]  const IPSEC_GETSPI1 *getSpi,
  [out] IPSEC_SA_SPI        *inboundSpi
);

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 SA context. This identifier was received from the system when the application called IPsecSaContextCreate1.

[in] getSpi

Type: IPSEC_GETSPI1*

The inbound IPsec traffic.

[out] 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 retrieved 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.

Requirements

Requirement	Value
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