IPsecDospStateEnum0 function (fwpmu.h)

The IPsecDospStateEnum0 function returns the next page of results from the IPsec DoS Protection state enumerator. Each IPsec DoS Protection state entry corresponds to a flow that has successfully passed the IPsec DoS Protection authentication checks.

Syntax

DWORD IPsecDospStateEnum0(
  [in]  HANDLE            engineHandle,
  [in]  HANDLE            enumHandle,
  [in]  UINT32            numEntriesRequested,
  [out] IPSEC_DOSP_STATE0 ***entries,
  [out] UINT32            *numEntries
);

Parameters

[in] engineHandle

Type: HANDLE

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

[in] enumHandle

Type: HANDLE

Handle for an IPsec DoS Protection enumeration. Call IPsecDospStateCreateEnumHandle0 to obtain an enumeration handle.

[in] numEntriesRequested

Type: UINT32

The number of enumeration entries requested.

[out] entries

Type: IPSEC_DOSP_STATE0***

Addresses of the enumeration entries.

[out] numEntries

Type: UINT32*

The number of enumeration entries returned.

Return value

Type: DWORD

Remarks

If the numEntries 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.

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

Requirements

See also

IPSEC_DOSP_STATE0

IPsecDospStateCreateEnumHandle0