IPsecSaContextGetById0 (Compact 2013)

3/26/2014

This function retrieves an IPsec security association (SA) context.

Syntax

DWORD IPsecSaContextGetById0(
  __in   HANDLE engineHandle,
  __in   UINT64 id,
  __out  IPSEC_SA_CONTEXT0** saContext
);

engineHandle
A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

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

saContext
Pointer to an IPSEC_SA_CONTEXT0* variable. On function return, it will contain the 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 topic WFP Error Codes for details.
RPC_* error code 0x80010001-0x80010122	Failure to communicate with the remote or local firewall engine.

ERROR_SUCCESS

The IPsec SA context was successfully retrieved.

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.

The caller must free the returned object, saContext, by a call to FwpmFreeMemory0.

The caller needs FWPM_ACTRL_READ access to the IPsec security association database. See WFP Access Right Identifiers for more information.

Header	fwpmu.h
Library	fwpuclnt.dll