Windows Dev Center

IPsecDospStateCreateEnumHandle0 function

The IPsecDospStateCreateEnumHandle0 function creates a handle used to enumerate a set of IPsec DoS Protection objects.

Syntax


DWORD WINAPI IPsecDospStateCreateEnumHandle0(
  _In_           HANDLE                          engineHandle,
  _In_opt_ const IPSEC_DOSP_STATE_ENUM_TEMPLATE0 *enumTemplate,
  _Out_          HANDLE                          *enumHandle
);

Parameters

engineHandle [in]

Type: HANDLE

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

enumTemplate [in, optional]

Type: const IPSEC_DOSP_STATE_ENUM_TEMPLATE0*

Template for selectively restricting the enumeration.

enumHandle [out]

Type: HANDLE*

Address of a HANDLE variable. On function return, it contains the handle for the newly created enumeration.

Return value

Type: DWORD

Return code/valueDescription
ERROR_SUCCESS
0

The enumeration was created 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 enumTemplate is NULL, all IPsec DoS Protection objects are returned.

The caller must call IPsecDospStateDestroyEnumHandle0 to free the returned handle.

The caller needs FWPM_ACTRL_READ_STATS access to the IPsec DoS Protection component. See Access Control for more information.

IPsecDospStateCreateEnumHandle0 is a specific implementation of IPsecDospStateCreateEnumHandle. 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

IPsecDospStateDestroyEnumHandle0
IPSEC_DOSP_STATE_ENUM_TEMPLATE0

 

 

Community Additions

ADD
Show:
© 2015 Microsoft