FwpmProviderContextGetById0 (Compact 2013)

3/26/2014

This function retrieves a provider context.

Syntax

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

engineHandle
A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

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

providerContext
Pointer to the address of a FWPM_PROVIDER_CONTEXT0 structure containing the provider context information.

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 topic WFP Error Codes for details.
RPC_* error code 0x80010001-0x80010122	Failure to communicate with the remote or local firewall engine.

ERROR_SUCCESS

The provider context was retrieved successfully.

FWP_E_* error code

0x80320001-0x80320039

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

RPC_* error code

0x80010001-0x80010122

Failure to communicate with the remote or local firewall engine.

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

The caller needs FWPM_ACTRL_READ access to the provider context. See WFP Access Right Identifiers for more information.

Header	fwpmu.h
Library	fwpuclnt.dll