IPsecSaContextGetById0 function (fwpmk.h)

  • Article

The IPsecSaContextGetById0 function retrieves an IPsec security association (SA) context.

Syntax

NTSTATUS IPsecSaContextGetById0(
  [in]  HANDLE            engineHandle,
  [in]  UINT64            id,
  [out] IPSEC_SA_CONTEXT0 **saContext
);

Parameters

[in] engineHandle

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

[in] id

A runtime identifier for the SA context. This identifier was received from the system when the application called IPsecSaContextCreate0.

[out] saContext

Address of the IPsec SA context.

Return value

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.

Remarks

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.

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