Share via

FwpmProviderAdd0 (Compact 2013)

  • Article

3/26/2014

This function adds a new provider to the system.

Syntax

DWORD WINAPI FwpmProviderAdd0(
  __in      HANDLE engineHandle,
  __in      const FWPM_PROVIDER0* provider,
  __in_opt  PSECURITY_DESCRIPTOR sd
);

Parameters

  • engineHandle
    A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.
  • provider
    Address of an FWPM_PROVIDER0 structure that describes the provider object to be added
  • sd
    A pointer to a SECURITY_DESCRIPTOR structure

Return Value

Return code / value

Description

ERROR_SUCCESS

0

The provider was successfully added

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

Remarks

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

Boot-time objects are added to the Base Filtering Engine (BFE) when the TCP/IP driver starts, and are removed once the BFE finishes initialization. Persistent objects are added when the BFE starts. If a policy provider has a persistent policy that is not intended to be enforced if its associated service is disabled, the caller can specify an optional service name in the FWPM_PROVIDER0 structure. This service then owns the persistent policy object. At start, the BFE only adds the following types of persistent objects to the system.

  • The object is not associated with a provider.
  • The object has an associated provider that does not specify a service name.
  • The object has an associated provider and an associated service set to auto-start.

This function cannot be called from within a read-only transaction. It will fail with FWP_E_INCOMPATIBLE_TXN.

The caller needs FWPM_ACTRL_ADD access to the provider's container. See WFP Access Right Identifiers for more information.

Requirements

Header

fwpmu.h

Library

fwpuclnt.dll

See Also

Reference

WFP Provider Management
WFP Access Right Identifiers

Other Resources

Windows Filtering Platform