DsBackupTruncateLogs function
[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 DsBackupTruncateLogs function truncates the previously read backup logs.
Syntax
HRESULT DsBackupTruncateLogs(
_In_ HBC hbc
);
Parameters
-
hbc [in]
-
Contains the backup context handle obtained with the DsBackupPrepare function.
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 is invalid.
Remarks
Use the DsBackupTruncateLogs function when a full or incremental backup has completed successfully.
Caution
If this function is called after a differential backup, all of the incremental backup information will be lost.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows Vista |
| Minimum supported server |
Windows Server 2008 |
| Header |
|
| Library |
|
| DLL |
|