FwpmCalloutGetSecurityInfoByKey0 function

The FwpmCalloutGetSecurityInfoByKey0 function retrieves a copy of the security descriptor for a callout object.

Syntax

DWORD FwpmCalloutGetSecurityInfoByKey0(
  HANDLE               engineHandle,
  const GUID           *key,
  SECURITY_INFORMATION securityInfo,
  PSID                 *sidOwner,
  PSID                 *sidGroup,
  PACL                 *dacl,
  PACL                 *sacl,
  PSECURITY_DESCRIPTOR *securityDescriptor
);

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*

Pointer to a GUID that uniquely identifies the callout. This GUID was specified in the calloutKey member of the callout parameter when the application called FwpmCalloutAdd0 for this object.

securityInfo

Type: SECURITY_INFORMATION

The type of security information to retrieve.

sidOwner

Type: PSID*

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

sidGroup

Type: PSID*

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

dacl

Type: PACL*

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

sacl

Type: PACL*

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

securityDescriptor

Type: PSECURITY_DESCRIPTOR*

The returned security descriptor.

Return Value

Type: DWORD

Return code/value Description
ERROR_SUCCESS
0
The security descriptor was retrieved 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 callouts 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.

FwpmCalloutGetSecurityInfoByKey0 is a specific implementation of FwpmCalloutGetSecurityInfoByKey. 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

FwpmCalloutSetSecurityInfoByKey0