FwpmLayerGetByKey0 function (fwpmk.h)

  • Article

The FwpmLayerGetByKey0 function retrieves a layer object.

Syntax

NTSTATUS FwpmLayerGetByKey0(
  [in]  HANDLE      engineHandle,
  [in]  const GUID  *key,
  [out] FWPM_LAYER0 **layer
);

Parameters

[in] engineHandle

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

[in] key

Unique identifier of the layer. See Filtering Layer Identifiers for a list of possible GUID values.

[out] layer

The layer information.

Return value

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

The caller must free the returned object by a call to FwpmFreeMemory0.

The caller needs FWPM_ACTRL_READ access to the layer. See Access Control for more information.

FwpmLayerGetByKey0 is a specific implementation of FwpmLayerGetByKey. 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