IPsecDospStateEnum0 function

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(
  HANDLE            engineHandle,
  HANDLE            enumHandle,
  UINT32            numEntriesRequested,
  IPSEC_DOSP_STATE0 ***entries,
  UINT32            *numEntries
);

Parameters

engineHandle

Type: HANDLE

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

enumHandle

Type: HANDLE

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

numEntriesRequested

Type: UINT32

The number of enumeration entries requested.

entries

Type: IPSEC_DOSP_STATE0***

Addresses of the enumeration entries.

numEntries

Type: UINT32*

The number of enumeration entries returned.

Return Value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
The results 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.

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

   
Minimum supported client Windows 7 [desktop apps only]
Minimum supported server Windows Server 2008 R2 [desktop apps only]
Target Platform Windows
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll

See Also

IPSEC_DOSP_STATE0

IPsecDospStateCreateEnumHandle0