IPsecSaContextEnum1 function (fwpmu.h)

Article
07/27/2022

The IPsecSaContextEnum1 function returns the next page of results from the IPsec security association (SA) context enumerator.

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

Syntax

DWORD IPsecSaContextEnum1(
  [in]  HANDLE            engineHandle,
  [in]  HANDLE            enumHandle,
  [in]  UINT32            numEntriesRequested,
  [out] IPSEC_SA_CONTEXT1 ***entries,
  [out] UINT32            *numEntriesReturned
);

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] enumHandle

Type: HANDLE

Handle for an SA context enumeration returned by IPsecSaContextCreateEnumHandle0.

[in] numEntriesRequested

Type: UINT32

Number of SA contexts requested.

[out] entries

Type: IPSEC_SA_CONTEXT1***

Addresses of the enumeration entries.

[out] numEntriesReturned

Type: UINT32*

The number of SA contexts returned.

Return value

Type: DWORD

Return code/value	Description
ERROR_SUCCESS 0	The IPsec SA contexts were enumerated 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

If the numEntriesReturned is less than the numEntriesRequested, the enumeration is exhausted.

The returned array of entries (but not the individual entries themselves) must be freed by a call to FwpmFreeMemory0.

Requirements

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