IVssExamineWriterMetadata::GetBackupSchema method (vsbackup.h)
The GetBackupSchema method is used by a requester to determine from the Writer Metadata Document the types of backup operations that a given writer can participate in.
Syntax
HRESULT GetBackupSchema(
DWORD *pdwSchemaMask
);
Parameters
pdwSchemaMask
The types of backup operations that a given writer supports, expressed as a bit mask (or bitwise OR) of VSS_BACKUP_SCHEMA enumeration values.
Return value
The following are the valid return codes for this method.
| Value | Meaning |
|---|---|
|
Successfully set the failure message. |
|
The backup schema argument is not valid. |
|
The caller is out of memory or other system resources. |
|
The XML document is not valid. Check the event log for details. For more information, see Event and Error Handling Under VSS. |
Remarks
The default backup schema is VSS_BS_UNDEFINED: the writer supports only simple full backup and restoration of entire files (as defined by VSS_BT_FULL), there is no support for incremental or differential backups, and partial files are not supported.
The writer calls IVssCreateWriterMetadata::SetBackupSchema to indicate its supported schema in its Writer Metadata Document.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | vsbackup.h (include VsBackup.h, Vss.h, VsWriter.h) |
| Library | VssApi.lib |