DsBackupGetBackupLogs function

Article
12/11/2020

[This function is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Beginning with Windows Vista, use Volume Shadow Copy Service (VSS) instead.]

The DsBackupGetBackupLogs function obtains the list of log files that must be backed up for the given backup context.

Syntax

HRESULT DsBackupGetBackupLogs(
  _In_  HBC     hbc,
  _Out_ LPTSTR  *pszBackupLogFiles,
  _Out_ LPDWORD pcbSize
);

Parameters

hbc [in]

Contains the backup context handle obtained with the DsBackupPrepare function.

pszBackupLogFiles [out]

Pointer to a string pointer that receives the list of log file names as UNC paths. Initialize this value to NULL before calling DsBackupGetBackupLogs.

This list receives a double null-terminated list of single null-terminated strings.

This buffer is allocated by the DsBackupGetBackupLogs function and must be freed when no longer required by calling the DsBackupFree function.

The first character of each of the file names contains one of the BFT Constants that identifies the type of name.

pcbSize [out]

Pointer to DWORD value that receives the size, in bytes, of the pszBackupLogFiles buffer.

Return value

Returns S_OK if the function is successful or a Win32 or RPC error code otherwise. The following list lists other possible error codes.

ERROR_ACCESS_DENIED: The caller does not have the proper access privileges to call this function. The DsSetAuthIdentity function can be used to set the credentials to use for the backup and restore functions.
ERROR_INVALID_PARAMETER: hbc, pszBackupLogFiles, or pcbSize is invalid.
ERROR_NOT_ENOUGH_MEMORY: A memory allocation failure occurred.

Remarks

The DsBackupGetBackupLogs function provides a list of the log files necessary for a backup. A full backup consists of the database files provided by the DsBackupGetDatabaseNames function and the log files. Incremental backups of Active Directory servers are not supported.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Header	Ntdsbcli.h
Library	Ntdsbcli.lib
DLL	Ntdsbcli.dll
Unicode and ANSI names	DsBackupGetBackupLogsW (Unicode) and DsBackupGetBackupLogsA (ANSI)