Edit

Share via

FwpmProviderContextAdd3 function (fwpmk.h)

  • Article

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

Syntax

NTSTATUS FwpmProviderContextAdd3(
  [in]            HANDLE                       engineHandle,
  [in]            const FWPM_PROVIDER_CONTEXT3 *providerContext,
  [in, optional]  PSECURITY_DESCRIPTOR         sd,
  [out, optional] UINT64                       *id
);

Parameters

[in] engineHandle

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

[in] providerContext

The provider context object to be added.

[in, optional] sd

Security information associated with the provider context object.

[out, optional] id

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

Return value

Return code/value Description
ERROR_SUCCESS
0		 The provider context was successfully added.
ERROR_NOT_SUPPORTED
0x32		 The FWPM_IPSEC_IKE_MM_CONTEXTand the 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.
Other NTSTATUS codes An error occurred.

Remarks

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

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

This function cannot be called from within a read-only transaction, it fails 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.

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

Requirements

Requirement Value
Minimum supported client Available starting with Windows Vista.
Target Platform Universal
Header fwpmk.h
Library fwpkclnt.lib
IRQL <= PASSIVE_LEVEL

See also