Edit

Share via

FwpmSubLayerAdd0 function (fwpmk.h)

  • Article

The FwpmSubLayerAdd0 function adds a new sublayer to the system.

Syntax

NTSTATUS FwpmSubLayerAdd0(
  [in]           HANDLE               engineHandle,
  [in]           const FWPM_SUBLAYER0 *subLayer,
  [in, optional] PSECURITY_DESCRIPTOR sd
);

Parameters

[in] engineHandle

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

[in] subLayer

The sublayer to be added.

[in, optional] sd

Security information for the sublayer object.

Return value

Return code/value Description
ERROR_SUCCESS
0		 The sublayer was successfully added.
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

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 fails with FWP_E_INCOMPATIBLE_TXN. See Object Management for more information about transactions.

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

FwpmSubLayerAdd0 is a specific implementation of FwpmSubLayerAdd. 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