Edit

Share via

IkeextSaGetById0 function (fwpmk.h)

  • Article

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

Syntax

NTSTATUS IkeextSaGetById0(
  [in]  HANDLE             engineHandle,
  [in]  UINT64             id,
  [out] IKEEXT_SA_DETAILS0 **sa
);

Parameters

[in] engineHandle

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

[in] id

The SA identifier.

[out] sa

Address of the SA details.

Return value

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.

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.

IkeextSaGetById0 is a specific implementation of IkeextSaGetById. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Requirements

Requirement Value
Minimum supported client Available starting with Windows Vista.
Target Platform Universal
Header fwpmk.h
Library fwpkclnt.lib
IRQL <= PASSIVE_LEVEL

See also