IVssWMFiledesc::GetBackupTypeMask method (vswriter.h)

Article
10/05/2021

The GetBackupTypeMask method returns the file backup specification for the files specified by the current file descriptor as a bit mask (or bitwise OR) of VSS_FILE_SPEC_BACKUP_TYPE values. This information indicates if the files are to be evaluated by their writer for participation in various specific types of backup operations (or if they will participate in an incremental or differential backups).

Syntax

HRESULT GetBackupTypeMask(
  DWORD *pdwTypeMask
);

Parameters

pdwTypeMask

Pointer to a DWORD containing a bit mask (or bitwise OR) of VSS_FILE_SPEC_BACKUP_TYPE values indicating the file backup specification for the file or file set described by the current IVssWMFiledesc interface.

Return value

The following are the valid return codes for this method.

Value	Meaning
S_OK	Successfully returned the filespec information.
E_INVALIDARG	The pdwTypeMask variable points to a NULL region of memory.
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_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

A file backup specification is specified by a writer when it adds a file specification to a component using the IVssCreateWriterMetadata::AddFilesToFileGroup, IVssCreateWriterMetadata::AddDatabaseFiles, or IVssCreateWriterMetadata::AddDatabaseLogFiles method.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [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