Share via

IPsecSaContextCreateEnumHandle0 (Compact 2013)

  • Article

3/26/2014

This function creates a handle used to enumerate a set of IPsec security association (SA) context objects.

Syntax

DWORD IPsecSaContextCreateEnumHandle0(
  __in      HANDLE engineHandle,
  __in_opt  const IPSEC_SA_CONTEXT_ENUM_TEMPLATE0* enumTemplate,
  __out     HANDLE* enumHandle
);

Parameters

  • engineHandle
    A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
  • enumHandle
    Address of a HANDLE variable. On function return, it contains the handle for SA context enumeration.

Return Value

Return code / value

Description

ERROR_SUCCESS

0

The enumerator 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 IPsec SA objects are returned.

The caller must call IPsecSaContextDestroyEnumHandle0 to free the returned handle.

The caller needs FWPM_ACTRL_ENUM and FWPM_ACTRL_READ access to the IPsec security association database. See WFP Access Right Identifiers for more information.

Requirements

Header

fwpmu.h

Library

fwpuclnt.dll

See Also

Reference

WFP IPsec Functions
IPsecSaContextDestroyEnumHandle0
WFP Access Right Identifiers

Other Resources

Windows Filtering Platform