nf-fwpmu-ikeextsagetbyid2.md

UID	title	description	helpviewer_keywords	old-location	tech.root	ms.assetid	ms.date	ms.keywords	req.header	req.include-header	req.target-type	req.target-min-winverclnt	req.target-min-winversvr	req.kmdf-ver	req.umdf-ver	req.ddi-compliance	req.unicode-ansi	req.idl	req.max-support	req.namespace	req.assembly	req.type-library	req.lib	req.dll	req.irql	targetos	req.typenames	req.redist	ms.custom	f1_keywords	dev_langs	topic_type	api_type	api_location	api_name
NF:fwpmu.IkeextSaGetById2	IkeextSaGetById2 function (fwpmu.h)	Retrieves an IKE/AuthIP security association (SA) from the database. (IkeextSaGetById2)	IkeextSaGetById2 IkeextSaGetById2 function [Filtering] fwp.ikeextsagetbyid2 fwpmu/IkeextSaGetById2	fwp\ikeextsagetbyid2.htm	fwp	5ea04fdc-d06d-4e8e-9c66-3a6df4372481	12/05/2018	IkeextSaGetById2, IkeextSaGetById2 function [Filtering], fwp.ikeextsagetbyid2, fwpmu/IkeextSaGetById2	fwpmu.h		Windows	Windows 8 [desktop apps only]	Windows Server 2012 [desktop apps only]										Fwpuclnt.lib	Fwpuclnt.dll		Windows			19H1	IkeextSaGetById2 fwpmu/IkeextSaGetById2	c++	APIRef kbSyntax	DllExport	Fwpuclnt.dll	IkeextSaGetById2

IkeextSaGetById2 function

-description

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.

 

-parameters

-param engineHandle [in]

Type: HANDLE

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

-param id [in]

Type: UINT64

The SA identifier.

-param saLookupContext [in, optional]

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.

-param sa [out]

Type: IKEEXT_SA_DETAILS2**

Address of the SA details.

-returns

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.

-see-also

IKEEXT_SA_DETAILS2