FwpmProviderContextSetSecurityInfoByKey0 function

The FwpmProviderContextSetSecurityInfoByKey0 function sets specified security information in the security descriptor of a provider context object.

Syntax

DWORD FwpmProviderContextSetSecurityInfoByKey0(
  HANDLE               engineHandle,
  const GUID           *key,
  SECURITY_INFORMATION securityInfo,
  const SID            *sidOwner,
  const SID            *sidGroup,
  const ACL            *dacl,
  const ACL            *sacl
);

Parameters

engineHandle

Type: HANDLE

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

key

Type: const GUID*

Unique identifier of the provider context object. This is a pointer to the same GUID that was specified when the application called FwpmProviderContextAdd0 for this object.

securityInfo

Type: SECURITY_INFORMATION

The type of security information to set.

sidOwner

Type: const SID*

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

sidGroup

Type: const SID*

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

dacl

Type: const ACL*

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

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 provider contexts 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.

FwpmProviderContextSetSecurityInfoByKey0 is a specific implementation of FwpmProviderContextSetSecurityInfoByKey. 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]
Target Platform Windows
Header fwpmu.h
Library Fwpuclnt.lib
DLL Fwpuclnt.dll

See Also

FwpmProviderContextGetSecurityInfoByKey0