Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
FwpmFilterSetSecurityInfoByKey0

FwpmFilterSetSecurityInfoByKey0 function

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

Syntax


DWORD WINAPI FwpmFilterSetSecurityInfoByKey0(
  _In_           HANDLE               engineHandle,
  _In_opt_ const GUID                 *key,
  _In_           SECURITY_INFORMATION securityInfo,
  _In_opt_ const SID                  *sidOwner,
  _In_opt_ const SID                  *sidGroup,
  _In_opt_ const ACL                  *dacl,
  _In_opt_ const ACL                  *sacl
);

Parameters

engineHandle [in]

Type: HANDLE

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

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.

securityInfo [in]

Type: SECURITY_INFORMATION

The type of security information to set.

sidOwner [in, optional]

Type: const SID*

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

sidGroup [in, optional]

Type: const SID*

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

dacl [in, optional]

Type: const ACL*

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

sacl [in, optional]

Type: const ACL*

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

Return value

Type: DWORD

Return code/valueDescription
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.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Header

Fwpmu.h

Library

Fwpuclnt.lib

DLL

Fwpuclnt.dll

See also

FwpmFilterGetSecurityInfoByKey0

 

 

Community Additions

ADD
Show:
© 2015 Microsoft