Share via

IkeextSaCreateEnumHandle0 (Compact 2013)

  • Article

3/26/2014

This function creates a handle used to enumerate a set of Internet Key Exchange (IKE) objects.

Syntax

DWORD WINAPI IkeextSaCreateEnumHandle0(
  __in      HANDLE engineHandle,
  __in_opt  const IKEEXT_SA_ENUM_TEMPLATE0* enumTemplate,
  __out     HANDLE* enumHandle
);

Parameters

  • engineHandle
    Handle for an open session to the filter engine generated by a previous call to FwpmEngineOpen0
  • enumHandle
    Address of a HANDLE variable. On function return, the HANDLE variable will contain 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 topic 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 IKE 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 security association database. See WFP Access Right Identifiers for more information.

Requirements

Header

fwpmu.h

Library

fwpuclnt.dll

See Also

Reference

WFP IKE Functions
WFP Functions
WFP Access Right Identifiers

Other Resources

Windows Filtering Platform