FwpmSessionCreateEnumHandle0 function

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

Syntax


DWORD WINAPI FwpmSessionCreateEnumHandle0(
  _In_           HANDLE                      engineHandle,
  _In_opt_ const FWPM_SESSION_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 FWPM_SESSION_ENUM_TEMPLATE0*

Template to selectively restrict the enumeration.

enumHandle [out]

Type: HANDLE*

Handle for filter enumeration.

Return value

Type: DWORD

Return code/valueDescription
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 session objects are returned.

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

FwpmSessionCreateEnumHandle0 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 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

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

FWPM_SESSION_ENUM_TEMPLATE0
FwpmSessionDestroyEnumHandle0

 

 

Show: