IkeextSaCreateEnumHandle0 function (fwpmu.h)

The IkeextSaCreateEnumHandle0 function creates a handle used to enumerate a set of Internet Key Exchange (IKE) and Authenticated Internet Protocol (AuthIP) security association (SA) objects.

Syntax

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

Parameters

[in] engineHandle

Type: HANDLE

Handle for an open session to the filter engine generated by a previous call to FwpmEngineOpen0.

[in, optional] enumTemplate

Type: IKEEXT_SA_ENUM_TEMPLATE0*

Template for selectively restricting the enumeration.

[out] enumHandle

Type: HANDLE*

Address of a HANDLE variable. On function return, it contains the handle of the newly created enumeration.

Return value

Type: DWORD

Remarks

If enumTemplate is NULL, all IKE/AuthIP SA objects are returned.

The caller must call IkeextSaDestroyEnumHandle0 to free the returned handle.

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

IkeextSaCreateEnumHandle0 is a specific implementation of IkeextSaCreateEnumHandle. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Requirements

See also

IKE/AuthIP Functions

WFP Functions

Windows Filtering Platform API Reference