Edit

Share via

IkeextSaGetById0 function (fwpmu.h)

  • Article

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

Note  IkeextSaGetById0 is the specific implementation of IkeextSaGetById used in Windows Vista. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows 7, IkeextSaGetById1 is available. For Windows 8, IkeextSaGetById2 is available.
 

Syntax

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

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

The SA identifier.

[out] sa

Type: IKEEXT_SA_DETAILS0**

Address of the SA details.

Return value

Type: DWORD

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.

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.

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

IKE/AuthIP Functions

IKEEXT_SA_DETAILS0

WFP Functions