IkeextSaGetById2 function (fwpmu.h)

Article
02/22/2024

The IkeextSaGetById2 function retrieves an IKE/AuthIP security association (SA) from the database.

Note IkeextSaGetById2 is the specific implementation of IkeextSaGetById used in Windows 8. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows 7, IkeextSaGetById1 is available. For Windows Vista, IkeextSaGetById0 is available.

Syntax

DWORD IkeextSaGetById2(
  [in]           HANDLE             engineHandle,
  [in]           UINT64             id,
  [in, optional] GUID               *saLookupContext,
  [out]          IKEEXT_SA_DETAILS2 **sa
);

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

The SA identifier.

[in, optional] saLookupContext

Type: GUID*

Optional pointer to the SA lookup context propagated from the SA to data connections flowing over that SA. It is made available to any application that queries socket security properties using the Winsock API WSAQuerySocketSecurity function, allowing the application to obtain detailed IPsec authentication information for its connection.

[out] sa

Type: IKEEXT_SA_DETAILS2**

Address of the SA details.

Return value

Type: DWORD

Return code/value	Description
ERROR_SUCCESS 0	The SA 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 must free sa by a call to FwpmFreeMemory0.

The caller needs FWPM_ACTRL_READ access to the IKE/AuthIP security associations database. See Access Control for more information.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	fwpmu.h
Library	Fwpuclnt.lib
DLL	Fwpuclnt.dll