Platform SDK: Active Directory, ADSI, and Directory Services

DsBackupGetBackupLogs

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

HRESULT DsBackupGetBackupLogs(
  HBC hbc,
  LPWSTR *pszBackupLogFiles,
  LPDWORD pcbSize
);

Parameters

hbc
[in] Points to the client context handle of the backup.
pszBackupLogFiles
[out] Pointer that will receive the pointer to the list of log files. Log files are returned in an array of null-terminated UNC filenames. The list is terminated by two-nulls (\0\0).

When the array is no longer needed, the caller should free the memory allocated for the array using DsBackupFree.

pcbSize
[out] Pointer to DWORD data type that specifies the number of bytes returned.

Return Values

One of the standard HRESULT success codes; otherwise, a failure code.

Remarks

The list of log files are the only files that need to be backed up for a differential or incremental backup. For a full backup, these files need to be backed up in addition to those that the DsBackupGetDatabaseNames function returns.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Ntdsbcli.h.
  Library: Included as a resource in Ntdsbcli.dll.
  Unicode: Implemented as Unicode and ANSI versions on Windows 2000.

See Also

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