Edit

Share via

IkeextSaCreateEnumHandle0 function (fwpmk.h)

  • Article

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

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

Parameters

[in] engineHandle

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

[in, optional] enumTemplate

Template for selectively restricting the enumeration.

[out] enumHandle

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

Return value

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.
Other NTSTATUS codes An error occurred.

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

Requirement Value
Minimum supported client Available starting with Windows Vista.
Target Platform Universal
Header fwpmk.h
Library fwpkclnt.lib
IRQL <= PASSIVE_LEVEL

See also