FwpmSessionCreateEnumHandle0 - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// fwpmk.h
NTSTATUS FwpmSessionCreateEnumHandle0(
[in] HANDLE engineHandle,
[in, optional] const FWPM_SESSION_ENUM_TEMPLATE0 *enumTemplate,
[out] HANDLE *enumHandle
);
View the official Windows Driver Kit DDI referenceNo description available.
The FwpmSessionCreateEnumHandle0 function creates a handle used to enumerate a set of session objects.
engineHandle [in]Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
enumTemplate [in, optional]Template to selectively restrict the enumeration.
enumHandle [out]Handle for filter enumeration.
| 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. |
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.