IkeextSaCreateEnumHandle0 function

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 WINAPI IkeextSaCreateEnumHandle0(
  _In_      HANDLE engineHandle,
  _In_opt_  const IKEEXT_SA_ENUM_TEMPLATE0 *enumTemplate,
  _Out_     HANDLE *enumHandle
);

Parameters

engineHandle [in]

Type: HANDLE

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

enumTemplate [in, optional]

Type: const IKEEXT_SA_ENUM_TEMPLATE0*

Template for selectively restricting the enumeration.

enumHandle [out]

Type: HANDLE*

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

Return value

Type: DWORD

Return code/valueDescription
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 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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

Windows Filtering Platform API Reference
WFP Functions
IKE/AuthIP Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft