Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The FwpmSessionCreateEnumHandle0 function creates a handle used to enumerate a set of session objects.
Syntax
DWORD FwpmSessionCreateEnumHandle0(
[in] HANDLE engineHandle,
[in, optional] const FWPM_SESSION_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_SESSION_ENUM_TEMPLATE0*
Template to selectively restrict the enumeration.
[out] enumHandle
Type: HANDLE*
Handle for filter enumeration.
Return value
Type: DWORD
| Return code/value | Description |
|---|---|
|
The enumerator was created successfully. |
|
A Windows Filtering Platform (WFP) specific error. See WFP Error Codes for details. |
|
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
| 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 |