IPsecSaContextGetById0 - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// fwpmk.h
NTSTATUS IPsecSaContextGetById0(
[in] HANDLE engineHandle,
[in] UINT64 id,
[out] IPSEC_SA_CONTEXT0 **saContext
);
View the official Windows Driver Kit DDI referenceNo description available.
The IPsecSaContextGetById0 function retrieves an IPsec 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 IPsecSaContextCreate0.
saContext [out]Address of the IPsec SA context.
| Return code/value | Description |
|---|---|
| ERROR_SUCCESS 0 |
The IPsec SA context was successfully retrieved. |
| 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 the returned object, saContext, by a call to FwpmFreeMemory0.
The caller needs FWPM_ACTRL_READ access to the IPsec security associations database.See Access Control for more information.
IPsecSaContextGetById0 is a specific implementation of IPsecSaContextGetById. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.