FwpmLayerGetById0 function (fwpmu.h)

  • Article

The FwpmLayerGetById0 function retrieves a layer object.

Syntax

DWORD FwpmLayerGetById0(
  [in]  HANDLE      engineHandle,
  [in]  UINT16      id,
  [out] FWPM_LAYER0 **layer
);

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] id

Type: UINT16

Identifier of the desired layer. For a list of possible values, see Run-time Filtering Layer Identifiers in the WDK documentation for Windows Filtering Platform.

[out] layer

Type: FWPM_LAYER0**

The layer information.

Return value

Type: DWORD

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.

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.

FwpmLayerGetById0 is a specific implementation of FwpmLayerGetById. See WFP Version-Independent Names and Targeting Specific Versions of Windows 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_LAYER0

Run-time Filtering Layer Identifiers