FwpmFilterGetSecurityInfoByKey0 function (fwpmu.h)

The FwpmFilterGetSecurityInfoByKey0 function retrieves a copy of the security descriptor for a filter object.

Syntax

DWORD FwpmFilterGetSecurityInfoByKey0(
  [in]            HANDLE               engineHandle,
  [in, optional]  const GUID           *key,
  [in]            SECURITY_INFORMATION securityInfo,
  [out, optional] PSID                 *sidOwner,
  [out, optional] PSID                 *sidGroup,
  [out, optional] PACL                 *dacl,
  [out, optional] PACL                 *sacl,
  [out]           PSECURITY_DESCRIPTOR *securityDescriptor
);

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 filter. This GUID was specified in the filterKey member of the filter parameter when the application called FwpmFilterAdd0 for this object.

[in] securityInfo

Type: SECURITY_INFORMATION

The type of security information to retrieve.

[out, optional] sidOwner

Type: PSID*

The owner security identifier (SID) in the returned security descriptor.

[out, optional] sidGroup

Type: PSID*

The primary group security identifier (SID) in the returned security descriptor.

[out, optional] dacl

Type: PACL*

The discretionary access control list (DACL) in the returned security descriptor.

[out, optional] sacl

Type: PACL*

The system access control list (SACL) in the returned security descriptor.

[out] securityDescriptor

Type: PSECURITY_DESCRIPTOR*

The returned security descriptor.

Return value

Type: DWORD

Remarks

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

The returned securityDescriptor parameter must be freed through a call to FwpmFreeMemory0. The other four (optional) returned parameters must not be freed, as they point to addresses within the securityDescriptor parameter.

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

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

Requirements

See also

FwpmFilterSetSecurityInfoByKey0