This topic has not yet been rated - Rate this topic

FwpmProviderContextAdd2 function

The FwpmProviderContextAdd2 function adds a new provider context to the system.

Note FwpmProviderContextAdd2 is the specific implementation of FwpmProviderContextAdd used in Windows 8. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information. For Windows 7, FwpmProviderContextAdd1 is available. For Windows Vista, FwpmProviderContextAdd0 is available.

Syntax

C++


DWORD WINAPI FwpmProviderContextAdd2(
  _In_       HANDLE engineHandle,
  _In_       const FWPM_PROVIDER_CONTEXT2 *providerContext,
  _In_opt_   PSECURITY_DESCRIPTOR sd,
  _Out_opt_  UINT64 *id
);

Parameters

engineHandle [in]

Type: HANDLE

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

providerContext [in]

Type: const FWPM_PROVIDER_CONTEXT2*

The provider context object to be added.

sd [in, optional]

Type: PSECURITY_DESCRIPTOR

Security information associated with the provider context object.

id [out, optional]

Type: UINT64*

Pointer to a variable that receives a runtime identifier for this provider context.

Return value

Type: DWORD

Return code/value	Description
ERROR_SUCCESS 0	The provider context was successfully added.
ERROR_NOT_SUPPORTED 0x32	The type member of the providerContext parameter is FWPM_IPSEC_IKE_MM_CONTEXT and the ikeMmPolicy member of the providerContext parameter contains an IKEEXT_IPV6_CGA authentication method in the authenticationMethods array, but cryptographically generated address (CGA) is not enabled in the registry.
*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

Some fields in the FWPM_PROVIDER_CONTEXT2 structure are assigned by the system, not the caller, and are ignored in the call to FwpmProviderContextAdd2.

If the caller supplies a NULL security descriptor, the system will assign a default security descriptor.

This function cannot be called from within a read-only transaction. It will fail with FWP_E_INCOMPATIBLE_TXN. See Object Management for more information about transactions.

The caller needs FWPM_ACTRL_ADD access to the provider context's container and FWPM_ACTRL_ADD_LINK access to the provider (if any). See Access Control for more information.

Requirements

Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Header	Fwpmu.h
Library	Fwpuclnt.lib
DLL	Fwpuclnt.dll

Community Additions

ADD