IVssCreateWriterMetadata::SetBackupSchema method

The SetBackupSchema method is used by a writer to indicate in its Writer Metadata Document the types of backup operations it can participate in.

Syntax


HRESULT SetBackupSchema(
  [in]  DWORD dsSchemaMask
);

Parameters

dsSchemaMask [in]

The types of backup operations this writer supports expressed as a bitmask of VSS_BACKUP_SCHEMA enumeration values.

For express writers, only the VSS_BS_UNDEFINED, VSS_BS_COPY, and VSS_BS_INDEPENDENT_SYSTEM_STATE values are supported.

Return value

The following are the valid return codes for this method.

ValueMeaning
S_OK
0x00000000L

Successfully set the failure message.

E_INVALIDARG
0x80070057L

The backup schema argument is not valid.

E_OUTOFMEMORY
0x8007000EL

The caller is out of memory or other system resources.

VSS_E_INVALID_XML_DOCUMENT
0x80042311L

The XML document is not valid. Check the event log for details. For more information, see Event and Error Handling Under VSS.

VSS_E_NOT_SUPPORTED
0x8004232FL

The caller specified a VSS_BACKUP_SCHEMA value that is not supported for express writers.

 

Remarks

If no schema is explicitly set by SetBackupSchema, the writer will be assigned the default value of 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.

Requesters call IVssExamineWriterMetadata::GetBackupSchema to retrieve a writer's backup schemas as set by SetBackupSchema.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

VsWriter.h (include Vss.h or VsWriter.h)

Library

VssApi.lib

See also

VSS_BACKUP_SCHEMA
IVssCreateWriterMetadata
IVssExamineWriterMetadata::GetBackupSchema

 

 

Community Additions

ADD
Show:
© 2014 Microsoft