Skip to content

Latest commit

 

History

History
161 lines (121 loc) · 5.18 KB

nf-fwpmu-fwpmfiltersetsecurityinfobykey0.md

File metadata and controls

161 lines (121 loc) · 5.18 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:fwpmu.FwpmFilterSetSecurityInfoByKey0
FwpmFilterSetSecurityInfoByKey0 function (fwpmu.h)
Sets specified security information in the security descriptor of a filter object.
FwpmFilterSetSecurityInfoByKey0
FwpmFilterSetSecurityInfoByKey0 function [Filtering]
fwp.fwpmfiltersetsecurityinfobykey0_func
fwpmu/FwpmFilterSetSecurityInfoByKey0
fwp\fwpmfiltersetsecurityinfobykey0_func.htm
fwp
01dac90a-98a0-46b7-8d9e-ce5fdf8014a9
12/05/2018
FwpmFilterSetSecurityInfoByKey0, FwpmFilterSetSecurityInfoByKey0 function [Filtering], fwp.fwpmfiltersetsecurityinfobykey0_func, fwpmu/FwpmFilterSetSecurityInfoByKey0
fwpmu.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Fwpuclnt.lib
Fwpuclnt.dll
Windows
19H1
FwpmFilterSetSecurityInfoByKey0
fwpmu/FwpmFilterSetSecurityInfoByKey0
c++
APIRef
kbSyntax
DllExport
Fwpuclnt.dll
FwpmFilterSetSecurityInfoByKey0

FwpmFilterSetSecurityInfoByKey0 function

-description

The FwpmFilterSetSecurityInfoByKey0 function sets specified security information in the security descriptor of a filter object.

-parameters

-param engineHandle [in]

Type: HANDLE

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

-param key [in, optional]

Type: const GUID*

Unique identifier of the filter. This GUID was specified in the filterKey member of the filter parameter when the application called FwpmFilterAdd0 for this object.

-param securityInfo [in]

Type: SECURITY_INFORMATION

The type of security information to set.

-param sidOwner [in, optional]

Type: const SID*

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

-param sidGroup [in, optional]

Type: const SID*

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

-param dacl [in, optional]

Type: const ACL*

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

-param sacl [in, optional]

Type: const ACL*

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

-returns

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 filters 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 can be called within a dynamic session if the corresponding object was added during the same session. If this function is called for an object that was added during a different dynamic session, it will fail with FWP_E_WRONG_SESSION. If this function is called for an object that was not added during a dynamic session, it will fail with FWP_E_DYNAMIC_SESSION_IN_PROGRESS.

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

FwpmFilterSetSecurityInfoByKey0 is a specific implementation of FwpmFilterSetSecurityInfoByKey. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

-see-also

FwpmFilterGetSecurityInfoByKey0