ObjectCloseAuditAlarmA function (winbase.h)

The ObjectCloseAuditAlarm function generates an audit message in the security event log when a handle to a private object is deleted. Alarms are not currently supported.


BOOL ObjectCloseAuditAlarmA(
  [in] LPCSTR SubsystemName,
  [in] LPVOID HandleId,
  [in] BOOL   GenerateOnClose


[in] SubsystemName

A pointer to a null-terminated string specifying the name of the subsystem calling the function. This string appears in any audit message that the function generates.

[in] HandleId

A unique value representing the client's handle to the object. This should be the same value that was passed to the AccessCheckAndAuditAlarm or ObjectOpenAuditAlarm function.

[in] GenerateOnClose

Specifies a flag set by a call to the AccessCheckAndAuditAlarm or ObjectCloseAuditAlarm function when the object handle is created. If this flag is TRUE, the function generates an audit message. If it is FALSE, the function does not generate an audit message.

Return value

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.


The ObjectCloseAuditAlarm function requires the calling application to have the SE_AUDIT_NAME privilege enabled. The test for this privilege is always performed against the primary token of the calling process, allowing the calling process to impersonate a client.


Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header winbase.h (include Windows.h)
Library Advapi32.lib
DLL Advapi32.dll

See also


Client/Server Access Control Functions

Client/Server Access Control Overview