IkeextSaGetById0 (Compact 2013)
3/26/2014
This function retrieves an IKE security association (SA) from the database.
Syntax
DWORD IkeextSaGetById0(
__in HANDLE engineHandle,
__in UINT64 id,
__out IKEEXT_SA_DETAILS0** sa
);
Parameters
- engineHandle
Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
- id
The SA identifier
- sa
Pointer to an IKEEXT_SA_DETAILS0* variable. On function return, it will contain the address of the SA details.
Return Value
Return code / value |
Description |
|---|---|
ERROR_SUCCESS 0 |
The SA was retrieved successfully |
ERROR_NOT_FOUND |
The SA ID was not found |
FWP_E_* error code 0x80320001-0x80320039 |
A Windows Filtering Platform (WFP) specific error. See topic 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 WFP Access Right Identifiers for more information.
Requirements
Header |
fwpmu.h |
Library |
fwpuclnt.dll |
See Also
Reference
WFP IKE Functions
FwpmFreeMemory0
WFP Access Right Identifiers