IPsecSaContextEnum0 function (fwpmk.h)

  • Article

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

Syntax

NTSTATUS IPsecSaContextEnum0(
  [in]  HANDLE            engineHandle,
  [in]  HANDLE            enumHandle,
  [in]  UINT32            numEntriesRequested,
  [out] IPSEC_SA_CONTEXT0 ***entries,
  [out] UINT32            *numEntriesReturned
);

Parameters

[in] engineHandle

Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

[in] enumHandle

Handle for an SA context enumeration returned by IPsecSaContextCreateEnumHandle0.

[in] numEntriesRequested

Number of SA contexts requested.

[out] entries

Addresses of the enumeration entries.

[out] numEntriesReturned

The number of SA contexts returned.

Return value

Return code/value Description
ERROR_SUCCESS
0		 The IPsec SA contexts were enumerated 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.
Other NTSTATUS codes An error occurred.

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.

IPsecSaContextEnum0 is a specific implementation of IPsecSaContextEnum. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Requirements

Requirement Value
Minimum supported client Available starting with Windows Vista.
Target Platform Universal
Header fwpmk.h
Library fwpkclnt.lib
IRQL <= PASSIVE_LEVEL

See also