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

Parameters

engineHandle [in]

Type: HANDLE

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

enumHandle [in]

Type: HANDLE

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

numEntriesRequested [in]

Type: UINT32

The number of enumeration entries requested.

entries [out]

Type: IPSEC_DOSP_STATE0***

Addresses of the enumeration entries.

numEntries [out]

Type: UINT32*

The number of enumeration entries returned.

Return value

Type: DWORD

Return code/valueDescription
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]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

IPsecDospStateCreateEnumHandle0
IPSEC_DOSP_STATE0

 

 

Show: