Edit

Share via

FwpmNetEventCreateEnumHandle0 function (fwpmu.h)

  • Article

The FwpmNetEventCreateEnumHandle0 function creates a handle used to enumerate a set of network events.

Syntax

DWORD FwpmNetEventCreateEnumHandle0(
  [in]           HANDLE                              engineHandle,
  [in, optional] const FWPM_NET_EVENT_ENUM_TEMPLATE0 *enumTemplate,
  [out]          HANDLE                              *enumHandle
);

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, optional] enumTemplate

Type: FWPM_NET_EVENT_ENUM_TEMPLATE0*

Template to selectively restrict the enumeration.

[out] enumHandle

Type: HANDLE*

The handle for network event enumeration.

Return value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
 The enumerator 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 network event objects are returned.

The caller must call FwpmNetEventDestroyEnumHandle0 to free the returned handle.

This function cannot be called from within a transaction. It will fail with FWP_E_TXN_IN_PROGRESS. See Object Management for more information about transactions.

The caller needs FWPM_ACTRL_ENUM access to the events' containers. See Access Control for more information.

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

Requirements

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

See also

FWPM_NET_EVENT_ENUM_TEMPLATE0

FwpmNetEventDestroyEnumHandle0