FwpmProviderContextGetById2 - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
// fwpmk.h

NTSTATUS FwpmProviderContextGetById2(
  [in]  HANDLE                 engineHandle,
  [in]  UINT64                 id,
  [out] FWPM_PROVIDER_CONTEXT2 **providerContext
);
View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Windows Driver Kit DDI reference (nf-fwpmk-fwpmprovidercontextgetbyid2)

Description

The FwpmProviderContextGetById2 function retrieves a provider context.

Parameters

engineHandle [in]

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

id [in]

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 FwpmProviderContextAdd2 for this object.

providerContext [out]

The provider context information.

Return value

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.
Other NTSTATUS codes An error occurred.

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.

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

See also