Edit

BackupEventLogW function (winbase.h)

  • Article

Saves the specified event log to a backup file. The function does not clear the event log.

Syntax

BOOL BackupEventLogW(
  [in] HANDLE  hEventLog,
  [in] LPCWSTR lpBackupFileName
);

Parameters

[in] hEventLog

A handle to the open event log. The OpenEventLog function returns this handle.

[in] lpBackupFileName

The absolute or relative path of the backup file.

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.

Remarks

The BackupEventLog function fails with the ERROR_PRIVILEGE_NOT_HELD error if the user does not have the SE_BACKUP_NAME privilege.

Note

The winbase.h header defines BackupEventLog as an alias which 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 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 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winbase.h (include Windows.h)
Library Advapi32.lib
DLL Advapi32.dll
API set ext-ms-win-advapi32-eventlog-ansi-l1-1-0 (introduced in Windows 10, version 10.0.10240)

See also

OpenBackupEventLog

OpenEventLog