AuthzInitializeObjectAccessAuditEvent2 function (authz.h)

The AuthzInitializeObjectAccessAuditEvent2 function allocates and initializes an AUTHZ_AUDIT_EVENT_HANDLE handle for use with the AuthzAccessCheck function.

Syntax

C++

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

Parameters

[in] Flags

Flags that modify the behavior of the audit. The following table shows the possible values.

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

[in] hAuditEventType

Reserved. This parameter should be set to NULL.

[in] szOperationType

A pointer to a string that indicates the operation that is to be audited.

[in] szObjectType

A pointer to a string that indicates the type of object accessed.

[in] szObjectName

A pointer to a string that indicates the name of the object accessed.

[in] szAdditionalInfo

Pointer to a string defined by the Resource Manager that contains additional audit information.

[in] szAdditionalInfo2

Pointer to a string defined by the Resource Manager that contains additional audit information.

[out] phAuditEvent

A pointer to the returned AUTHZ_AUDIT_EVENT_HANDLE handle.

[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	None supported
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