Edit

Share via

FwpmSessionCreateEnumHandle0 function (fwpmk.h)

  • Article

The FwpmSessionCreateEnumHandle0 function creates a handle used to enumerate a set of session objects.

Syntax

NTSTATUS FwpmSessionCreateEnumHandle0(
  [in]           HANDLE                            engineHandle,
  [in, optional] const FWPM_SESSION_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 to selectively restrict the enumeration.

[out] enumHandle

Handle for filter 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 objects are returned.

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

FwpmSessionCreateEnumHandle0 cannot be called from within a transaction, it fails with FWP_E_TXN_IN_PROGRESS. See Object Management for more information about transactions.

The caller needs FWPM_ACTRL_ENUM access to the filter engine. See Access Control for more information.

FwpmSessionCreateEnumHandle0 is a specific implementation of FwpmSessionCreateEnumHandle. See WFP Version-Independent Names and Targeting Specific Versions of Windows 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