FwpmProviderCreateEnumHandle0 function (fwpmu.h)

The FwpmProviderCreateEnumHandle0 function creates a handle used to enumerate a set of providers.

Syntax

DWORD FwpmProviderCreateEnumHandle0(
  [in]           HANDLE                             engineHandle,
  [in, optional] const FWPM_PROVIDER_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_PROVIDER_ENUM_TEMPLATE0*

Template to selectively restrict the enumeration.

[out] enumHandle

Type: HANDLE*

Handle for provider enumeration.

Return value

Type: DWORD

Remarks

If enumTemplate is NULL, all providers are returned.

The enumerator is not "live", meaning it does not reflect changes made to the system after the call to FwpmProviderCreateEnumHandle0 returns. If you need to ensure that the results are current, you must call FwpmProviderCreateEnumHandle0 and FwpmProviderEnum0 from within the same explicit transaction.

The caller must free the returned handle by a call to FwpmProviderDestroyEnumHandle0.

The caller needs FWPM_ACTRL_ENUM access to the providers' containers and FWPM_ACTRL_READ access to the providers. Only providers to which the caller has FWPM_ACTRL_READ access will be returned. See Access Control for more information.

FwpmProviderCreateEnumHandle0 is a specific implementation of FwpmProviderCreateEnumHandle. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Requirements

See also

FWPM_PROVIDER_ENUM_TEMPLATE0

FwpmProviderDestroyEnumHandle0