FwpmConnectionCreateEnumHandle0 function (fwpmk.h)

  • Article

The FwpmConnectionCreateEnumHandle0 function creates a handle used to enumerate a set of connection objects.

Syntax

NTSTATUS FwpmConnectionCreateEnumHandle0(
  [in]           HANDLE                               engineHandle,
  [in, optional] const FWPM_CONNECTION_ENUM_TEMPLATE0 *enumTemplate,
  [out]          HANDLE                               *enumHandle
);

Parameters

[in] engineHandle

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

[in, optional] enumTemplate

Template for selectively restricting the enumeration.

[out] enumHandle

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

Return value

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.
Other NTSTATUS codes An error occurred.

Remarks

If enumTemplate is NULL, all connection objects are returned.

The caller must free the returned handle by a call to FwpmConnectionDestroyEnumHandle0.

The caller needs FWPM_ACTRL_ENUM access to the connection objects' containers and FWPM_ACTRL_READ access to the connection objects. See Access Control for more information.

Requirements

Requirement Value
Minimum supported client Available starting with Windows Vista.
Target Platform Universal
Header fwpmk.h
Library fwpkclnt.lib
IRQL <= PASSIVE_LEVEL

See also