IPsecSaContextGetSpi1 function

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

engineHandle [in]

Type: HANDLE

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

id [in]

Type: UINT64

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

getSpi [in]

Type: const IPSEC_GETSPI1*

The inbound IPsec traffic.

inboundSpi [out]

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/valueDescription
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

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

IPSEC_GETSPI1
IPsecSaContextCreate0

 

 

Show: