OpenBackupEventLog function

Opens a handle to a backup event log created by the BackupEventLog function.

Syntax


HANDLE OpenBackupEventLog(
  _In_  LPCTSTR lpUNCServerName,
  _In_  LPCTSTR lpFileName
);

Parameters

lpUNCServerName [in]

The Universal Naming Convention (UNC) name of the remote server on which this operation is to be performed. If this parameter is NULL, the local computer is used.

lpFileName [in]

The full path of the backup file.

Return value

If the function succeeds, the return value is a handle to the backup event log.

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

Remarks

If the backup filename specifies a remote server, the lpUNCServerName parameter must be NULL.

When this function is used on Windows Vista and later computers, only backup event logs that were saved with the BackupEventLog function on Windows Vista and later computers can be opened.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winbase.h (include Windows.h)

Library

Advapi32.lib

DLL

Advapi32.dll

Unicode and ANSI names

OpenBackupEventLogW (Unicode) and OpenBackupEventLogA (ANSI)

See also

Event Logging Functions
BackupEventLog

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.