IPsecSaContextGetById0 function (fwpmu.h)

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

Note  IPsecSaContextGetById0 is the specific implementation of IPsecSaContextGetById used in Windows Vista. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows 7 and later, IPsecSaContextGetById1 is available.
 

Syntax

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

Parameters

[in] engineHandle

Type: HANDLE

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

[in] id

Type: UINT64

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

[out] saContext

Type: IPSEC_SA_CONTEXT0**

Address of the IPsec SA context.

Return value

Type: DWORD

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.

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.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll

See also

IPSEC_SA_CONTEXT0

IPsecSaContextCreate0