Skip to content

Latest commit

 

History

History
165 lines (133 loc) · 5.36 KB

nf-vswriter-ivsswmfiledesc-getbackuptypemask.md

File metadata and controls

165 lines (133 loc) · 5.36 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:vswriter.IVssWMFiledesc.GetBackupTypeMask
IVssWMFiledesc::GetBackupTypeMask (vswriter.h)
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.
GetBackupTypeMask
GetBackupTypeMask method [VSS]
GetBackupTypeMask method [VSS]
IVssWMFiledesc interface
IVssWMFiledesc interface [VSS]
GetBackupTypeMask method
IVssWMFiledesc.GetBackupTypeMask
IVssWMFiledesc::GetBackupTypeMask
base.ivsswmfiledesc_getbackuptypemask
vswriter/IVssWMFiledesc::GetBackupTypeMask
base\ivsswmfiledesc_getbackuptypemask.htm
base
9d5f3a16-2053-42dd-867d-740c4a34bdb6
12/05/2018
GetBackupTypeMask, GetBackupTypeMask method [VSS], GetBackupTypeMask method [VSS],IVssWMFiledesc interface, IVssWMFiledesc interface [VSS],GetBackupTypeMask method, IVssWMFiledesc.GetBackupTypeMask, IVssWMFiledesc::GetBackupTypeMask, base.ivsswmfiledesc_getbackuptypemask, vswriter/IVssWMFiledesc::GetBackupTypeMask
vswriter.h
Vss.h, VsWriter.h
Windows
Windows Vista [desktop apps only]
Windows Server 2003 [desktop apps only]
VssApi.lib
Windows
19H1
IVssWMFiledesc::GetBackupTypeMask
vswriter/IVssWMFiledesc::GetBackupTypeMask
c++
APIRef
kbSyntax
COM
VssApi.lib
VssApi.dll
IVssWMFiledesc.GetBackupTypeMask

IVssWMFiledesc::GetBackupTypeMask

-description

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).

-parameters

-param 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.

-returns

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.

-see-also

IVssCreateWriterMetadata::AddDatabaseFiles

IVssCreateWriterMetadata::AddDatabaseLogFiles

IVssCreateWriterMetadata::AddFilesToFileGroup

IVssWMFiledesc

VSS_FILE_SPEC_BACKUP_TYPE