IPsecSaContextGetSpi0 function (fwpmk.h)

  • Article

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

Syntax

NTSTATUS IPsecSaContextGetSpi0(
  [in]  HANDLE              engineHandle,
  [in]  UINT64              id,
  [in]  const IPSEC_GETSPI0 *getSpi,
  [out] IPSEC_SA_SPI        *inboundSpi
);

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

[in] getSpi

The inbound IPsec traffic.

[out] inboundSpi

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

Return value

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.
Other NTSTATUS codes An error occurred.

Remarks

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

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

Requirements

Requirement Value
Minimum supported client Available starting with Windows Vista.
Target Platform Universal
Header fwpmk.h
Library fwpkclnt.lib
IRQL <= PASSIVE_LEVEL

See also