Share via

IPsecSaEnum0 (Compact 7)

  • Article

3/12/2014

This function returns the next page of results from the IPsec security association (SA) enumerator.

Syntax

DWORD WINAPI IPsecSaEnum0(
  __in   HANDLE engineHandle,
  __in   HANDLE enumHandle,
  __in   UINT32 numEntriesRequested,
  __out  IPSEC_SA_DETAILS0*** entries,
  __out  UINT32* numEntriesReturned
);

Parameters

  • engineHandle
    A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
  • numEntriesRequested
    Number of enumeration entries requested.
  • entries
    Pointer to the array of addresses of enumeration entries. See topic IPSEC_SA_DETAILS0 for more information.
  • numEntriesReturned
    Pointer to an UINT32 variable that will contain the number of enumeration entries returned.

Return Value

Return code / value Description

ERROR_SUCCESS

0

The SAs were enumerated 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 the numEntriesReturned is less than the numEntriesRequested, the enumeration is exhausted.

The returned array of entries (but not the individual entries themselves) must be freed by a call to FwpmFreeMemory0.

A subsequent call using the same enumeration handle will return the next set of items following those in the last output buffer.

IPsecSaEnum0 works on a snapshot of the SAs taken at the time the enumeration handle was created.

Requirements

Header

fwpmu.h

Library

fwpuclnt.dll

See Also

Reference

WFP IPsec Functions
FwpmFreeMemory0

Other Resources

Windows Filtering Platform