IPsecSaContextGetSpi1 - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// fwpmk.h
NTSTATUS IPsecSaContextGetSpi1(
[in] HANDLE engineHandle,
[in] UINT64 id,
[in] const IPSEC_GETSPI1 *getSpi,
[out] IPSEC_SA_SPI *inboundSpi
);
View the official Windows Driver Kit DDI referenceNo description available.
The IPsecSaContextGetSpi1 function retrieves the security parameters index (SPI) for a security association (SA) context.
engineHandle [in]Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
id [in]A runtime identifier for the SA context. This identifier was received from the system when the application called IPsecSaContextCreate1.
getSpi [in]The inbound IPsec traffic.
inboundSpi [out]The inbound SA SPI. The IPSEC_SA_SPI data type maps to the UINT32 data type.
| 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. |
The caller needs FWPM_ACTRL_ADD access to the IPsec security associations database. See Access Control for more information.
IPsecSaContextGetSpi1 is a specific implementation of IPsecSaContextGetSpi. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.