FwpmProviderContextGetById0 function

The FwpmProviderContextGetById0 function retrieves a provider context.

Note  FwpmProviderContextGetById0 is the specific implementation of FwpmProviderContextGetById used in Windows Vista. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows 7, FwpmProviderContextGetById1 is available. For Windows 8, FwpmProviderContextGetById2 is available.
 

Syntax

DWORD FwpmProviderContextGetById0(
  HANDLE                 engineHandle,
  UINT64                 id,
  FWPM_PROVIDER_CONTEXT0 **providerContext
);

Parameters

engineHandle

Type: HANDLE

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

id

Type: UINT64

A run-time identifier for the desired object. This must be the run-time identifier that was received from the system when the application called FwpmProviderContextAdd0 for this object.

providerContext

Type: FWPM_PROVIDER_CONTEXT0**

The provider context information.

Return Value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
The provider context was retrieved 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

The caller must free the returned object by a call to FwpmFreeMemory0.

The caller needs FWPM_ACTRL_READ access to the provider context. See Access Control for more information.

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll

See Also

FWPM_PROVIDER_CONTEXT0

FwpmEngineOpen0