IPsecSaEnum0 function (fwpmu.h)

Article
02/22/2024

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

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

Syntax

DWORD IPsecSaEnum0(
  [in]  HANDLE            engineHandle,
  [in]  HANDLE            enumHandle,
  [in]  UINT32            numEntriesRequested,
  [out] IPSEC_SA_DETAILS0 ***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 IPsec SA enumeration. Call IPsecSaCreateEnumHandle0 to obtain an enumeration handle.

[in] numEntriesRequested

Type: UINT32

The number of enumeration entries requested.

[out] entries

Type: IPSEC_SA_DETAILS0***

Addresses of the enumeration entries.

[out] numEntriesReturned

Type: UINT32*

The number of enumeration entries returned.

Return value

Type: DWORD

Return code/value	Description
ERROR_SUCCESS 0	The SAs 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.

A subsequent call using the same enumeration handle will return the next set of items following those in the last output buffer.

IPsecSaEnum0 works on a snapshot of the SAs taken at the time the enumeration handle was created.

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