AuthzInstallSecurityEventSource function (authz.h)

The AuthzInstallSecurityEventSource function installs the specified source as a security event source.

Syntax

AUTHZAPI BOOL AuthzInstallSecurityEventSource(
  [in] DWORD                             dwFlags,
  [in] PAUTHZ_SOURCE_SCHEMA_REGISTRATION pRegistration
);

Parameters

[in] dwFlags

This parameter is reserved for future use and must be set to zero.

[in] pRegistration

A pointer to an AUTHZ_SOURCE_SCHEMA_REGISTRATION structure that contains information about the security event source to be added.

The members of the AUTHZ_SOURCE_SCHEMA_REGISTRATION structure are used as follows to install the security event source in the security log key:

  • The szEventSourceName member is added as a registry key under
    HKEY_LOCAL_MACHINE
       SYSTEM
          CurrentControlSet
             Services
                EventLog
                   Security
  • The szEventMessageFile member is added as the data in a REG_SZ value named EventMessageFile under the event source key.
  • The szEventAccessStringsFile member is added as the data in a REG_SZ value named ParameterMessageFile under the event source key.
  • If the registry path does not exist, it is created.
  • If the szEventSourceXmlSchemaFile member is not NULL, it is added as the data in a REG_SZ value named XmlSchemaFile under the event source key. This value is not used.
  • The szExecutableImagePath member may be set to NULL.

Return value

If the function succeeds, the function 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

AUTHZ_SOURCE_SCHEMA_REGISTRATION

AuthzUninstallSecurityEventSource