IkeextSaGetById1 - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// fwpmk.h
NTSTATUS IkeextSaGetById1(
[in] HANDLE engineHandle,
[in] UINT64 id,
[in., optional] GUID *saLookupContext,
[out] IKEEXT_SA_DETAILS1 **sa
);
View the official Windows Driver Kit DDI referenceNo description available.
The IkeextSaGetById1 function retrieves an IKE/AuthIP security association (SA) from the database.
engineHandle [in]Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
id [in]The SA identifier.
saLookupContext [in., optional]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.
sa [out]Address of the SA details.
| 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. |
| Other NTSTATUS codes | An error occurred. |
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.
IkeextSaGetById1 is a specific implementation of IkeextSaGetById. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.