DsBackupGetBackupLogs

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

HRESULT DsBackupGetBackupLogs(
  HBC hbc,
  LPTSTR* pszBackupLogFiles,
  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. This value must be initialized to NULL prior to 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 it is no longer needed 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 Values

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 are not supported.

Requirements

Client: Included in Windows XP and Windows 2000 Professional.
Server: Included in Windows Server 2003 and Windows 2000 Server.
Unicode: Implemented as Unicode and ANSI versions.
Header: Declared in Ntdsbcli.h.
Library: Use Ntdsbcli.lib.

See Also

DsBackupFree, DsBackupGetDatabaseNames, BFT Constants, Directory Backup Functions, Backing Up and Restoring Active Directory