FwpmLayerGetByKey0 function (fwpmu.h)
The FwpmLayerGetByKey0 function retrieves a layer object.
Syntax
DWORD FwpmLayerGetByKey0(
[in] HANDLE engineHandle,
[in] const GUID *key,
[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] key
Type: const GUID*
Unique identifier of the layer. See Filtering Layer Identifiers for a list of possible GUID values.
[out] layer
Type: FWPM_LAYER0**
The layer information.
Return value
Type: DWORD
| Return code/value | Description |
|---|---|
|
The layer was retrieved successfully. |
|
A Windows Filtering Platform (WFP) specific error. See WFP Error Codes for details. |
|
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.
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 | 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 |