FwpsAleEndpointCreateEnumHandle0 function (fwpsk.h)

Article
02/22/2024

The FwpsAleEndpointCreateEnumHandle0 function creates a handle that can be used with other application layer enforcement (ALE) endpoint functions to enumerate endpoint data.

Note FwpsAleEndpointCreateEnumHandle0 is a specific version of FwpsAleEndpointCreateEnumHandle. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Syntax

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

Parameters

[in] engineHandle

Handle for an open session with the filter engine. This handle is obtained when a session is opened by calling FwpmEngineOpen0.

[in, optional] enumTemplate

A pointer to an FWPS_ALE_ENDPOINT_ENUM_TEMPLATE0 structure that contains parameters to narrow the endpoint enumeration results.

[out] enumHandle

The newly created enumeration handle.

Return value

The FwpsAleEndpointCreateEnumHandle0 function returns one of the following NTSTATUS codes.

Return code	Description
STATUS_SUCCESS	The function succeeded.
Other status codes	An error occurred.

Remarks

After using the handle acquired by calling FwpsAleEndpointCreateEnumHandle0, the callout driver must release the system resources associated with the handle by calling FwpsAleEndpointDestroyEnumHandle0.

Requirements

Requirement	Value
Minimum supported client	Available starting with Windows 7.
Target Platform	Universal
Header	fwpsk.h (include Fwpsk.h)
Library	Fwpkclnt.lib
IRQL	PASSIVE_LEVEL