FwpmProviderContextAdd0 function (fwpmu.h)

  • Article

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

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

 

Syntax

DWORD FwpmProviderContextAdd0(
  [in]            HANDLE                       engineHandle,
  [in]            const FWPM_PROVIDER_CONTEXT0 *providerContext,
  [in, optional]  PSECURITY_DESCRIPTOR         sd,
  [out, optional] UINT64                       *id
);

Parameters

[in] engineHandle

Type: HANDLE

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

[in] providerContext

Type: FWPM_PROVIDER_CONTEXT0*

The provider context object to be added.

[in, optional] sd

Type: PSECURITY_DESCRIPTOR

Security information associated with the provider context object.

[out, optional] id

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 [FWPM_IPSEC_IKE_MM_CONTEXT](/windows/desktop/api/fwpmtypes/ne-fwpmtypes-fwpm_provider_context_type)and the [IKEEXT_IPV6_CGA](/windows/desktop/api/iketypes/ne-iketypes-ikeext_authentication_method_type) 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_CONTEXT0 structure are assigned by the system, not the caller, and are ignored in the call to FwpmProviderContextAdd0.

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

Requirement Value
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