FwpmLayerSetSecurityInfoByKey0 function (fwpmu.h)

Article
10/13/2021

The FwpmLayerSetSecurityInfoByKey0 function sets specified security information in the security descriptor of a layer object.

Syntax

DWORD FwpmLayerSetSecurityInfoByKey0(
  [in]           HANDLE               engineHandle,
  [in, optional] const GUID           *key,
  [in]           SECURITY_INFORMATION securityInfo,
  [in, optional] const SID            *sidOwner,
  [in, optional] const SID            *sidGroup,
  [in, optional] const ACL            *dacl,
  [in, optional] const ACL            *sacl
);

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, optional] key

Type: const GUID*

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

[in] securityInfo

Type: SECURITY_INFORMATION

The type of security information to set.

[in, optional] sidOwner

Type: const SID*

The owner's security identifier (SID) to be set in the security descriptor.

[in, optional] sidGroup

Type: const SID*

The group's SID to be set in the security descriptor.

[in, optional] dacl

Type: const ACL*

The discretionary access control list (DACL) to be set in the security descriptor.

[in, optional] sacl

Type: const ACL*

The system access control list (SACL) to be set in the security descriptor.

Return value

Type: DWORD

Return code/value	Description
ERROR_SUCCESS 0	The security descriptor was set 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

If the key parameter is NULL or if it is a NULL GUID, this function manages the security information of the layers container.

This function cannot be called from within a transaction. It will fail with FWP_E_TXN_IN_PROGRESS. See Object Management for more information about transactions.

This function behaves like the standard Win32 SetSecurityInfo function. The caller needs the same standard access rights as described in the SetSecurityInfo reference topic.

FwpmLayerSetSecurityInfoByKey0 is a specific implementation of FwpmLayerSetSecurityInfoByKey. 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