FwpmProviderContextCreateEnumHandle0 function

The FwpmProviderContextCreateEnumHandle0 function creates a handle used to enumerate a set of provider contexts.

Syntax


DWORD WINAPI FwpmProviderContextCreateEnumHandle0(
  _In_      HANDLE engineHandle,
  _In_opt_  const FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0 *enumTemplate,
  _Out_     HANDLE *enumHandle
);

Parameters

engineHandle [in]

Type: HANDLE

Handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

enumTemplate [in, optional]

Type: const FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0*

Template to selectively restrict the enumeration.

enumHandle [out]

Type: HANDLE*

Handle for provider context enumeration.

Return value

Type: DWORD

Return code/valueDescription
ERROR_SUCCESS
0

The enumerator was created successfully.

FWP_E_* error code
0x80320001—0x80320039

A Windows Filtering Platform (WFP) specific error. See WFP Error Codes for details.

RPC_* error code
0x80010001—0x80010122

Failure to communicate with the remote or local firewall engine.

 

Remarks

If enumTemplate is NULL, all provider contexts are returned.

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

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

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

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

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

FWPM_PROVIDER_CONTEXT_ENUM_TEMPLATE0
FwpmProviderContextDestroyEnumHandle0

 

 

Community Additions

ADD
Show:
© 2014 Microsoft