FwpsAleEndpointCreateEnumHandle0 function

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 NTAPI FwpsAleEndpointCreateEnumHandle0(
  _In_           HANDLE                           engineHandle,
  _In_opt_ const FWPS_ALE_ENDPOINT_ENUM_TEMPLATE0 *enumTemplate,
  _Out_          HANDLE                           *enumHandle
);

Parameters

engineHandle [in]

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

enumTemplate [in, optional]

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

enumHandle [out]

The newly created enumeration handle.

Return value

The FwpsAleEndpointCreateEnumHandle0 function returns one of the following NTSTATUS codes.

Return codeDescription
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

Target platform

Universal

Version

Available starting with Windows 7.

Header

Fwpsk.h (include Fwpsk.h)

Library

Fwpkclnt.lib

IRQL

PASSIVE_LEVEL

See also

FwpsAleEndpointDestroyEnumHandle0
FwpsAleEndpointEnum0

 

 

Send comments about this topic to Microsoft

Show: