IPsecSaCreateEnumHandle0 function (fwpmu.h)

Article
10/13/2021

The IPsecSaCreateEnumHandle0 function creates a handle used to enumerate a set of Internet Protocol Security (IPsec) security association (SA) objects.

Syntax

DWORD IPsecSaCreateEnumHandle0(
  [in]           HANDLE                        engineHandle,
  [in, optional] const IPSEC_SA_ENUM_TEMPLATE0 *enumTemplate,
  [out]          HANDLE                        *enumHandle
);

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, optional] enumTemplate

Type: IPSEC_SA_ENUM_TEMPLATE0*

Template to selectively restrict the enumeration.

[out] enumHandle

Type: HANDLE*

Handle of the newly created enumeration.

Return value

Type: DWORD

Return code/value	Description
ERROR_SUCCESS 0	The enumeration was created 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 enumTemplate is NULL, all IPsec SA objects are returned.

The caller must call IPsecSaDestroyEnumHandle0 to free the returned handle.

The caller needs FWPM_ACTRL_READ and FWPM_ACTRL_ENUM access to the IPsec security associations database. See Access Control for more information.

IPsecSaCreateEnumHandle0 is a specific implementation of IPsecSaCreateEnumHandle. See WFP Version-Independent Names and Targeting Specific Versions of Windows 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