FwpsAleEndpointEnum0 function (fwpsk.h)

The FwpsAleEndpointEnum0 function enumerates application layer enforcement (ALE) endpoints.

Syntax

NTSTATUS FwpsAleEndpointEnum0(
  [in]  HANDLE                        engineHandle,
  [in]  HANDLE                        enumHandle,
  [in]  UINT32                        numEntriesRequested,
  [out] FWPS_ALE_ENDPOINT_PROPERTIES0 ***entries,
  [out] UINT32                        *numEntriesReturned
);

Parameters

[in] engineHandle

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

[in] enumHandle

The enumeration handle created by a previous call to FwpsAleEndpointDestroyEnumHandle0.

[in] numEntriesRequested

The maximum number of endpoint property entries to return. The actual number of entries enumerated is returned in numEntriesReturned. The actual number is less than the requested number only if fewer endpoints than the requested are present.

[out] entries

A pointer to an array of FWPS_ALE_ENDPOINT_PROPERTIES0 structure pointers. Each structure contains the properties of a single endpoint. The array contains as many elements as the value returned in numEntriesReturned.

[out] numEntriesReturned

On return, the number of elements in the array of endpoint property structures pointed to by entries.

Return value

The FwpsAleEndpointEnum0 function returns one of the following NTSTATUS codes.

Remarks

To enumerate ALE endpoints, the callout driver must first obtain an enumeration handle by calling FwpsAleEndpointCreateEnumHandle0. The handle returned is associated with any parameters specified in the optional enumTemplate parameter of FwpsAleEndpointCreateEnumHandle0.

After obtaining a handle, the callout driver can call FwpsAleEndpointEnum0 to get information about the endpoints that match the enumeration parameters of the handle.

Note that the localV4Address field from the returned FWPS_ALE_ENDPOINT_PROPERTIES0 is in host-byte order, while the localV6Address is in network-byte order. To use the IPv4 address from the localV4Address field, you must call htonl() on the localV4Address to store it in an in_addr structure and ensure the sockaddr is correctly formatted.

When finished examining endpoint properties, the callout driver must call FwpsAleEndpointDestroyEnumHandle0 to release the system resources associated with the enumeration handle.

Requirements

See also

FwpsAleEndpointGetById0