AuditSetGlobalSaclW function (ntsecapi.h)

Article
02/22/2024

The AuditSetGlobalSacl function sets a global system access control list (SACL) that delegates access to the audit messages. Updating the global SACL requires the SeSecurityPrivilege which protects the global SACL from being updated by any user without administrator privileges.

Syntax

BOOLEAN AuditSetGlobalSaclW(
  [in]           PCWSTR ObjectTypeName,
  [in, optional] PACL   Acl
);

Parameters

[in] ObjectTypeName

A pointer to a null-terminated string specifying the type of object being created or accessed. For setting the global SACL on files, this should be set to "File" and for setting the global SACL on registry, this should be set to "Key". This string appears in any audit message that the function generates.

[in, optional] Acl

A pointer to an ACL structure.

Return value

If the function succeeds, it returns TRUE.

If the function fails, it returns FALSE. To get extended error information, call GetLastError. GetLastError may return one of the following error codes defined in WinError.h.

Return code/value	Description
ERROR_ACCESS_DENIED 5	The caller does not have the privilege or access rights necessary to call this function.
ERROR_INVALID_PARAMETER 87	One or more parameters are invalid.

Remarks

To successfully call this function, the caller must have SeSecurityPrivilege.

Note

The ntsecapi.h header defines AuditSetGlobalSacl as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	ntsecapi.h
Library	Advapi32.lib
DLL	Advapi32.dll

Share via