AuthzInitializeObjectAccessAuditEvent function (authz.h)

The AuthzInitializeObjectAccessAuditEvent function initializes auditing for an object.

Syntax

C++

AUTHZAPI BOOL AuthzInitializeObjectAccessAuditEvent(
  [in]  DWORD                         Flags,
  [in]  AUTHZ_AUDIT_EVENT_TYPE_HANDLE hAuditEventType,
  [in]  PWSTR                         szOperationType,
  [in]  PWSTR                         szObjectType,
  [in]  PWSTR                         szObjectName,
  [in]  PWSTR                         szAdditionalInfo,
  [out] PAUTHZ_AUDIT_EVENT_HANDLE     phAuditEvent,
  [in]  DWORD                         dwAdditionalParameterCount,
        ...                           
);

Parameters

[in] Flags

Modifies the audit. This parameter can be one of the following values.

Value	Meaning
AUTHZ_NO_SUCCESS_AUDIT	Disable generation of success audits.
AUTHZ_NO_FAILURE_AUDIT	Disable generation of failure audits.
AUTHZ_NO_ALLOC_STRINGS	Use pointers to the passed strings instead of allocating memory and copying the strings. The calling application must ensure that the passed memory stays valid during access checks.

[in] hAuditEventType

Reserved. This parameter should be set to NULL.

[in] szOperationType

String that indicates the operation that is to be audited.

[in] szObjectType

String that indicates the type of object being accessed.

[in] szObjectName

String the indicates the name of the object being accessed.

[in] szAdditionalInfo

String, defined by the Resource Manager, for additional audit information.

[out] phAuditEvent

Pointer that receives an AUTHZ_AUDIT_EVENT_HANDLE structure.

[in] dwAdditionalParameterCount

Must be set to zero.

...

Additional parameters.

Return value

If the function succeeds, it returns TRUE.

If the function fails, it returns FALSE. For extended error information, call GetLastError.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	authz.h
Library	Authz.lib
DLL	Authz.dll
Redistributable	Windows Server 2003 Administration Tools Pack on Windows XP

See also

AuthzAccessCheck

Basic Access Control Functions