FwpmSubLayerGetByKey0 (Compact 2013)

3/26/2014

This function retrieves a sub-layer by its key.

Syntax

DWORD WINAPI FwpmSubLayerGetByKey0(
  __in   HANDLE engineHandle,
  __in   const GUID* key,
  __out  FWPM_SUBLAYER0** subLayer
);

engineHandle
A handle for an open session to the filter engine. Call FwpmEngineOpen0 to open a session to the filter engine.

key
Pointer to a GUID that uniquely identifies the sub-layer. This is a pointer to the same GUID that was specified when the application called FwpmSubLayerAdd0 for this object.

subLayer
Pointer to the address of a FWPM_SUBLAYER0 structure containing the sub-layer information.

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

ERROR_SUCCESS

The sub-layer was retrieved successfully.

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.

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

The caller needs FWPM_ACTRL_READ access to the sub-layer. See WFP Access Right Identifiers for more information.

Header	fwpmu.h
Library	fwpuclnt.dll