Share via

IPsecSaContextGetSpi0 (Compact 7)

  • Article

3/12/2014

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

Syntax

DWORD IPsecSaContextGetSpi0(
  __in   HANDLE engineHandle,
  __in   UINT64 id,
  __in   const IPSEC_GETSPI0* getSpi,
  __out  IPSEC_SA_SPI* inboundSpi
);

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 SA context. This identifier was received from the system when the application called IPsecSaContextCreate0.
  • getSpi
    Address of an IPSEC_GETSPI0 structure that describes the inbound IPsec traffic.
  • inboundSpi
    Address of an IPSEC_SA_SPI variable. On function return, the IPSEC_SA_SPI variable will contain 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 topic 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 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