IVssCreateWriterMetadata::AddDatabaseLogFiles method (vswriter.h)

Article
10/13/2021

The AddDatabaseLogFiles method indicates the log files that are associated with a database to be backed up, as well as their location.

Syntax

HRESULT AddDatabaseLogFiles(
  [in] LPCWSTR wszLogicalPath,
  [in] LPCWSTR wszDatabaseName,
  [in] LPCWSTR wszPath,
  [in] LPCWSTR wszFilespec,
  [in] DWORD   dwBackupTypeMask
);

Parameters

[in] wszLogicalPath

Pointer to a null-terminated wide character string containing the logical path of the database component to which the log files will be added.

For more information, see Logical Pathing of Components.

A logical path is not required, and can be NULL.

[in] wszDatabaseName

Pointer to a null-terminated wide character string containing the name of the database component associated with the log files. The type of this component must be VSS_CT_DATABASE; otherwise, the method will return an error.

[in] wszPath

Pointer to a null-terminated wide character string containing the path of the directory containing the log files.

The directory can be a local directory on the VSS machine, or it can be a file share directory on a remote file server.

UNC paths are supported.

The path can contain environment variables (for example, %SystemRoot%) but cannot contain wildcard characters.

There is no requirement that the path end with a backslash (""). It is up to applications that retrieve this information to check.

[in] wszFilespec

Pointer to a null-terminated wide character string containing the file specification of the log file(s) associated with the database.

A file specification cannot contain directory specifications (for example, no backslashes) but can contain the ? and * wildcard characters.

[in] dwBackupTypeMask

A bit mask (or bitwise OR) of VSS_FILE_SPEC_BACKUP_TYPE enumeration values to indicate if a writer should evaluate the file for participation in a certain type of backup operations.

The default value for this argument is (VSS_FSBT_ALL_BACKUP_REQUIRED | VSS_FSBT_ALL_SNAPSHOT_REQUIRED).

Return value

The following are the valid return codes for this method.

Value	Meaning
S_OK	The operation was successful.
E_INVALIDARG	One of the parameter values is not valid, or the caller attempted to add database files to a non-database component.
E_OUTOFMEMORY	The caller is out of memory or other system resources.
VSS_E_INVALID_XML_DOCUMENT	The XML document is not valid. Check the event log for details. For more information, see Event and Error Handling Under VSS.
VSS_E_OBJECT_NOT_FOUND	The specified component does not exist.
VSS_E_UNEXPECTED	Unexpected error. The error code is logged in the error log file. For more information, see Event and Error Handling Under VSS. Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP: This value is not supported until Windows Server 2008 R2 and Windows 7. E_UNEXPECTED is used instead.

Remarks

Windows 7, Windows Server 2008 R2, Windows Vista, Windows Server 2008, Windows XP and Windows Server 2003: Remote file shares are not supported until Windows 8 and Windows Server 2012. Writers support only local resources—sets of files whose absolute path starts with a valid local volume specification and cannot be a mapped network drive. Therefore, path inputs (wszPath) to AddDatabaseLogFiles (after the resolution of any environment variables) must be in this format.

This method can be called multiple times for a particular database component, which might be needed when several log files are stored on separate volumes.

The values of the wszLogicalPath and wszDatabaseName parameters should match those of one of the database components previously added with the IVssCreateWriterMetadata::AddComponent method.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	vswriter.h (include Vss.h, VsWriter.h)
Library	VssApi.lib