IkeextSaEnum0 (Compact 7)

3/12/2014

This function returns the next page of results from the Internet Key Exchange (IKE) IP security association enumerator.

Syntax

DWORD IkeextSaEnum0(
  __in   HANDLE engineHandle,
  __in   HANDLE enumHandle,
  __in   UINT32 numEntriesRequested,
  __out  IKEEXT_SA_DETAILS0*** entries,
  __out  UINT32* numEntriesReturned
);

Parameters

• engineHandle
  Handle for an open session to the Windows Filtering Platform (WFP) filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

• enumHandle
  Handle for an IKE/AuthIP SA enumeration. Call IkeextSaCreateEnumHandle0 to obtain an enumeration handle.

• numEntriesRequested
  Number of enumeration entries requested.

• entries
  Pointer to the array of addresses of enumeration entries. See topic IKEEXT_SA_DETAILS0 for more information.

• numEntriesReturned
  Pointer to an UINT32 variable that will contain the number of enumeration entries returned.

Return Value

Remarks

If the numEntriesReturned is less than the numEntriesRequested, the enumeration is exhausted.

To free the returned array of entries, but not the individual entries themselves, call FwpmFreeMemory0.

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

This function works on a snapshot of the security associations that were enumerated successfully at the time the enumeration handle was created.

Requirements

See Also

Reference

WFP IKE Functions
FwpmFreeMemory0

Other Resources

Windows Filtering Platform