vswriter.h header

2023-01-24

This header is used by System Services. For more information, see:

System Services

vswriter.h contains the following programming interfaces:

Classes


CVssWriter The CVssWriter class is an abstract base class that defines the interface by which a writer synchronizes its state with VSS and other writers.
CVssWriterEx The CVssWriterEx class is an abstract base class that defines the interface by which a writer synchronizes its state with VSS and other writers.
CVssWriterEx2 The CVssWriterEx2 class is an abstract base class that defines the interface by which a writer synchronizes its state with VSS and other writers.
IVssComponent The IVssComponent interface is a C++ (not COM) interface containing methods for examining and modifying information about components contained in a requester's Backup Components Document.
IVssComponentEx Defines additional methods for examining and modifying information about components contained in a requester's Backup Components Document.
IVssComponentEx2 Defines additional methods for reporting and retrieving component-level writer errors.
IVssCreateExpressWriterMetadata The IVssCreateExpressWriterMetadata interface is a COM interface containing methods to construct the Writer Metadata Document for an express writer.
IVssCreateWriterMetadata The IVssCreateWriterMetadata interface is a C++ (not COM) interface containing methods to construct the Writer Metadata Document in response to an Identify event. It is used only in the CVssWriter::OnIdentify method.
IVssCreateWriterMetadataEx The IVssCreateWriterMetadataEx interface is a C++ (not COM) interface that defines a method to report any file sets that will be explicitly excluded when a shadow copy is created.
IVssExpressWriter Defines methods to manage metadata for a VSS express writer.
IVssWMDependency The IVssWMDependency is a C++ (not COM) interface returned by the IVssWMComponent interface and used by applications when backing up or restoring a component that has an explicit writer-component dependency on a component managed by another writer.
IVssWMFiledesc The IVssWMFiledesc interface is a C++ (not COM) interface returned to a calling application by a number of query methods. It provides detailed information about a file or set of files (a file set).
IVssWriterComponents Contains methods used to obtain and modify component information.

Functions


CreateVssExpressWriter The CreateVssExpressWriter function (vswriter.h) creates an IVssExpressWriter interface object and returns a pointer to it.
CreateVssExpressWriterInternal The CreateVssExpressWriterInternal function (vswriter.h) creates an IVssExpressWriter interface object and returns a pointer to it.
CreateWriter This function is reserved for system use. (CreateWriter)
CreateWriterEx This function is reserved for system use. (CreateWriterEx)

Enumerations


VSS_ALTERNATE_WRITER_STATE Used to indicate whether a given writer has an associated alternate writer.
VSS_COMPONENT_FLAGS Used by writers to indicate support for auto-recovery.
VSS_COMPONENT_TYPE Specify the type of component being used with a shadow copy backup operation.
VSS_FILE_RESTORE_STATUS Defines the set of statuses of a file restore operation.
VSS_RESTORE_TARGET Used by a writer at restore time to indicate how all the files included in a selected component, and all the files in any component set it defines, are to be restored.
VSS_RESTOREMETHOD_ENUM Used by a writer at backup time to specify through its Writer Metadata Document the default file restore method.
VSS_SOURCE_TYPE Specifies the type of data that a writer manages.
VSS_SUBSCRIBE_MASK Indicates the events that the writer is willing to receive.
VSS_USAGE_TYPE Specifies how the host system uses the data managed by a writer involved in a VSS operation.
VSS_WRITERRESTORE_ENUM Indicate to a requester the conditions under which it will handle events generated during a restore operation.