FwpmLayerSetSecurityInfoByKey0 function (fwpmk.h)

  • Article

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

Syntax

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

Parameters

[in] engineHandle

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

key

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

securityInfo

The type of security information to set.

sidOwner

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

sidGroup

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

dacl

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

sacl

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

Return value

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.
Other NTSTATUS codes An error occurred.

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 fails 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 Available starting with Windows Vista.
Target Platform Universal
Header fwpmk.h
Library fwpkclnt.lib
IRQL <= PASSIVE_LEVEL

See also