Expand Minimize

FwpsAleEndpointEnum0 function

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

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

Syntax


NTSTATUS NTAPI FwpsAleEndpointEnum0(
  _In_   HANDLE engineHandle,
  _In_   HANDLE enumHandle,
  _In_   UINT32 numEntriesRequested,
  _Out_  FWPS_ALE_ENDPOINT_PROPERTIES0 ***entries,
  _Out_  UINT32 *numEntriesReturned
);

Parameters

engineHandle [in]

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

enumHandle [in]

The enumeration handle created by a previous call to FwpsAleEndpointDestroyEnumHandle0.

numEntriesRequested [in]

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.

entries [out]

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.

numEntriesReturned [out]

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.

Return codeDescription
STATUS_SUCCESS

The function succeeded.

Other status codes

An error occurred.

 

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.

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

Requirements

Version

Available starting with Windows 7.

Header

Fwpsk.h (include Fwpsk.h)

IRQL

PASSIVE_LEVEL

See also

FwpsAleEndpointCreateEnumHandle0
FwpsAleEndpointDestroyEnumHandle0
FwpsAleEndpointGetById0
FwpsAleEndpointGetSecurityInfo0
FwpsAleEndpointSetSecurityInfo0

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft