IkeextSaGetById1 function

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

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

Syntax


DWORD WINAPI IkeextSaGetById1(
  _In_     HANDLE             engineHandle,
  _In_     UINT64             id,
  _In_opt_ GUID               *saLookupContext,
  _Out_    IKEEXT_SA_DETAILS1 **sa
);

Parameters

engineHandle [in]

Type: HANDLE

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

id [in]

Type: UINT64

The SA identifier.

saLookupContext [in, optional]

Type: GUID*

Optional pointer to the SA lookup context propagated from the SA to data connections flowing over that SA. It is made available to any application that queries socket security properties using the Winsock API WSAQuerySocketSecurity function, allowing the application to obtain detailed IPsec authentication information for its connection.

sa [out]

Type: IKEEXT_SA_DETAILS1**

Address of the SA details.

Return value

Type: DWORD

Return code/valueDescription
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

Minimum supported client

Windows 7 [desktop apps only]

Minimum supported server

Windows Server 2008 R2 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

IKEEXT_SA_DETAILS1
WFP Functions
IKE/AuthIP Functions

 

 

Show: