diff options
| author | Kenneth Skovhede <kenneth@hexad.dk> | 2014-07-22 17:30:01 +0400 |
|---|---|---|
| committer | Kenneth Skovhede <kenneth@hexad.dk> | 2014-07-22 17:30:01 +0400 |
| commit | 26d6508baca652fcb872223f640a8d3bbce76f12 (patch) | |
| tree | 0dfe167e1f060c32f48af780aa2c835cfab1e743 /thirdparty/alphavss | |
| parent | ae8e7245f0e9b26026cc270a8bc64f5301b07668 (diff) | |
Updated AlphaVSS to the newest release 1.2.4000.3
Diffstat (limited to 'thirdparty/alphavss')
| -rwxr-xr-x | thirdparty/alphavss/Bin/AlphaVSS.Common.dll | bin | 78336 -> 73216 bytes | |||
| -rwxr-xr-x | thirdparty/alphavss/Bin/AlphaVSS.Common.xml | 7216 | ||||
| -rwxr-xr-x | thirdparty/alphavss/platform/AlphaVSS.51.x86.dll | bin | 168960 -> 176128 bytes | |||
| -rwxr-xr-x | thirdparty/alphavss/platform/AlphaVSS.52.x64.dll | bin | 208896 -> 223744 bytes | |||
| -rwxr-xr-x | thirdparty/alphavss/platform/AlphaVSS.52.x86.dll | bin | 184832 -> 190464 bytes | |||
| -rwxr-xr-x | thirdparty/alphavss/platform/AlphaVSS.60.x64.dll | bin | 233984 -> 243712 bytes | |||
| -rwxr-xr-x | thirdparty/alphavss/platform/AlphaVSS.60.x86.dll | bin | 203264 -> 208384 bytes |
7 files changed, 3608 insertions, 3608 deletions
diff --git a/thirdparty/alphavss/Bin/AlphaVSS.Common.dll b/thirdparty/alphavss/Bin/AlphaVSS.Common.dll Binary files differindex 6046ca342..90e56e34a 100755 --- a/thirdparty/alphavss/Bin/AlphaVSS.Common.dll +++ b/thirdparty/alphavss/Bin/AlphaVSS.Common.dll diff --git a/thirdparty/alphavss/Bin/AlphaVSS.Common.xml b/thirdparty/alphavss/Bin/AlphaVSS.Common.xml index 89ac2bd77..4a26cc3cd 100755 --- a/thirdparty/alphavss/Bin/AlphaVSS.Common.xml +++ b/thirdparty/alphavss/Bin/AlphaVSS.Common.xml @@ -4,23 +4,130 @@ <name>AlphaVSS.Common</name>
</assembly>
<members>
- <member name="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException">
+ <member name="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata">
<summary>
- Exception indicating that the writer operation failed because of a time-out between the Freeze and Thaw events. The recommended way to
- handle this error code is to wait ten minutes and then repeat the operation, up to three times.
+ A class that allows a requester to examine the metadata of a specific writer instance. This metadata may come from a
+ currently executing (live) writer, or it may have been stored as an XML document.
</summary>
+ <remarks>
+ A <see cref="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata"/> interface to a live writer's metadata is obtained by a call to
+ <see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterMetadata"/>.
+ </remarks>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssRetryableWriterException">
+ <member name="M:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.LoadFromXml(System.String)">
<summary>
- Exception indicating that the writer failed due to an error that would likely not occur if the entire backup, restore, or
- shadow copy creation process was restarted. The recommended way to handle this error is to wait ten minutes and then
- repeat the operation, up to three times.
+ The <see cref="M:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.LoadFromXml(System.String)"/> method loads an XML document that contains a writer's metadata document into a
+ <see cref="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata"/> instance.
</summary>
+ <param name="xml">String that contains an XML document that represents a writer's metadata document.</param>
+ <returns><see langword="true"/> if the XML document was successfully loaded, or <see langword="false"/> if the XML document could not
+ be loaded.</returns>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssWriterException">
+ <member name="M:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.SaveAsXml">
<summary>
- Base class for exceptions thrown to indicate errors reported by VSS writers.
- </summary>
+ The <see cref="M:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.SaveAsXml"/> method saves the Writer Metadata Document that contains a writer's state information to a specified string.
+ This string can be saved as part of a backup operation.
+ </summary>
+ <returns>The Writer Metadata Document that contains a writer's state information.</returns>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.BackupSchema">
+ <summary>
+ The <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.BackupSchema"/> is examined by a requester to determine from the
+ Writer Metadata Document the types of backup operations that a given writer can participate in.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.AlternateLocationMappings">
+ <summary>
+ The alternate location mappings of the file sets.
+ </summary>
+ <value>A read-only list containing the alternate location mappings of the file sets.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.RestoreMethod">
+ <summary>
+ Information about how a writer wants its data to be restored.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Components">
+ <summary>
+ Obtains the Writer Metadata Documents the components supported by this writer.
+ </summary>
+ <value>the Writer Metadata Documents the components supported by this writer.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.ExcludeFiles">
+ <summary>Information about files that have been explicitly excluded from backup.</summary>
+ <value>a read-only list containing information about files that have been explicitly excluded from backup.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.InstanceId">
+ <summary>
+ The instance identifier of the writer
+ </summary>
+ <value>The instance id.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.WriterId">
+ <summary>The class ID of the writer</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.WriterName">
+ <summary>A string specifying the name of the writer</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Usage">
+ <summary>A <see cref="T:Alphaleonis.Win32.Vss.VssUsageType"/> enumeration value indicating how the data managed by the writer is used on the host system.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Source">
+ <summary>A <see cref="T:Alphaleonis.Win32.Vss.VssSourceType"/> enumeration value indicating the type of data managed by the writer.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.InstanceName">
+ <summary>
+ Gets the writer instance name.
+ </summary>
+ <remarks>
+ <note>
+ <para>
+ <b>Windows XP and Windows 2003:</b> This property is not supported until Windows 2003 SP1 and will always return
+ <see langword="null"/> on those systems.
+ </para>
+ </note>
+ </remarks>
+ <value>A string specifying the writer instance name.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Version">
+ <summary>
+ Gets the version information for a writer application.
+ </summary>
+ <value>The version information for a writer application.</value>
+ <remarks>
+ <para>
+ Only the <see cref="P:System.Version.Major"/> and <see cref="P:System.Version.Minor"/> properties of the <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Version"/> instance
+ are used by VSS.
+ </para>
+ <para>
+ <note><b>Windows XP and Windows 2003:</b> This property is not supported until Windows Vista, and will always return version 0.0.0.0</note>
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.ExcludeFromSnapshotFiles">
+ <summary>
+ Obtains information about file sets that have been explicitly excluded from a given shadow copy.
+ </summary>
+ <remarks>
+ <para>
+ The <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.ExcludeFromSnapshotFiles"/> property is intended to report information about file sets excluded from a
+ shadow copy. Requesters should not exclude files from backup based on the information returned by this method.
+ </para>
+ <para>
+ <note>
+ <para><b>Windows XP and Windows 2003:</b> This property is not supported until Windows Vista and will always return an empty list.</para>
+ </note>
+ </para>
+ </remarks>
+ <value>The exclude from snapshot files.</value>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException">
+ <summary>
+ Exception thrown to indicate that an unexpected error occurred during communication with writers.
+ </summary>
+ <remarks>
+ The error code is logged in the error log file.
+ </remarks>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssException">
<summary>
@@ -55,6 +162,130 @@ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
+ <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException"/>
+ class with a system-supplied message describing the error.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException"/> class with a specified error message.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException">
+ <summary>
+ Exception thrown to indicate that the system was unable to freeze the Distributed Transaction Coordinator (DTC)
+ or the Kernel Transaction Manager (KTM).
+ </summary>
+ <remarks>
+ <note>
+ <b>Windows Server 2003 and Windows XP:</b> This exception is not supported until Windows Vista.
+ </note>
+ </remarks>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/>
+ class with a system-supplied message describing the error.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/> class with a specified error message.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo">
+ <summary>
+ Represents information about a Subcomponent associated with a given component.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo.#ctor(System.String,System.String)">
+ <summary>
+ Initializes a new instance of <see cref="T:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo"/>.
+ </summary>
+ <param name="logicalPath">The logical path of the Subcomponent. This can not be empty when working with Subcomponents.</param>
+ <param name="componentName">The name of the Subcomponent. This can not be empty.</param>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo.LogicalPath">
+ <summary>The logical path of the Subcomponent. This can not be empty when working with Subcomponents.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo.ComponentName">
+ <summary>The name of the Subcomponent. This can not be empty.</summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.IVssWriterComponents">
+ <summary>
+ The <see cref="T:Alphaleonis.Win32.Vss.IVssWriterComponents"/> interface contains methods used to obtain and modify component information
+ (in the form of <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> instances) associated with a given writer but stored in a
+ requester's Backup Components Document.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWriterComponents.Components">
+ <summary>
+ A read-only collection of <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> instances to the a given writer's
+ components explicitly stored in the Backup Components Document.
+ </summary>
+ <value>A read-only collection of <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> instances to the a given writer's
+ components explicitly stored in the Backup Components Document. <note type="caution">This list
+ must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note>
+ </value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWriterComponents.InstanceId">
+ <summary>
+ Identifier of the writer instance responsible for the components.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWriterComponents.WriterId">
+ <summary>
+ Identifier of the writer class responsible for the components.
+ </summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException">
+ <summary>
+ Exception indicating that the writer is not responding.
+ </summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssWriterException">
+ <summary>
+ Base class for exceptions thrown to indicate errors reported by VSS writers.
+ </summary>
+ </member>
<member name="M:Alphaleonis.Win32.Vss.VssWriterException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterException"/> class.
@@ -83,27 +314,27 @@ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssRetryableWriterException.#ctor">
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterNotRespondingException.#ctor">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRetryableWriterException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException"/> class.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssRetryableWriterException.#ctor(System.String)">
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterNotRespondingException.#ctor(System.String)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRetryableWriterException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException"/> class.
</summary>
<param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssRetryableWriterException.#ctor(System.String,System.Exception)">
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterNotRespondingException.#ctor(System.String,System.Exception)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRetryableWriterException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException"/> class.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssRetryableWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterNotRespondingException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRetryableWriterException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
@@ -114,158 +345,297 @@ The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssTimeoutWriterException.#ctor">
+ <member name="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException"/> class.
+ Exception thrown to indicate that the writer infrastructure is not operating properly.
</summary>
+ <remarks>
+ Check that the Event Service and VSS have been started, and check for errors associated with those services in the error log.
+ </remarks>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssTimeoutWriterException.#ctor(System.String)">
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterInfrastructureException.#ctor">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException"/>
+ class with a system-supplied message describing the error.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterInfrastructureException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssTimeoutWriterException.#ctor(System.String,System.Exception)">
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterInfrastructureException.#ctor(System.String,System.Exception)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssTimeoutWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterInfrastructureException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="info"/> parameter is <see langword="null"/>.
- </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">
- The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
- </exception>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssUsageType">
- <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssUsageType"/> enumeration specifies how the host system uses the data managed by a writer involved in a VSS operation.</summary>
- <remarks>Requester applications that are interested in backing up system state should look for writers with the
- <see cref="F:Alphaleonis.Win32.Vss.VssUsageType.BootableSystemState"/> or <see cref="F:Alphaleonis.Win32.Vss.VssUsageType.SystemService"/> usage type.</remarks>
+ <member name="T:Alphaleonis.Win32.Vss.VssVolumeInUseException">
+ <summary>
+ Exception indicating that the volume was in use and could not be locked.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssUsageType.Undefined">
- <summary><para>The usage type is not known.</para><para>This indicates an error on the part of the writer.</para></summary>
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeInUseException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException"/>
+ class with a system-supplied message describing the error.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssUsageType.BootableSystemState">
- <summary>The data stored by the writer is part of the bootable system state.</summary>
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeInUseException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException"/> class with a specified error message.
+ </summary>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssUsageType.SystemService">
- <summary>The writer either stores data used by a system service or is a system service itself.</summary>
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeInUseException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssUsageType.UserData">
- <summary>The data is user data.</summary>
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeInUseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssUsageType.Other">
- <summary>Unclassified data.</summary>
+ <member name="T:Alphaleonis.Win32.Vss.VssWriterRestore">
+ <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssWriterRestore"/> enumeration is used by a writer to indicate to a requester the
+ conditions under which it will handle events generated during a restore operation.</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssRestoreTarget">
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterRestore.Undefined">
<summary>
- <para>
- The <see cref="T:Alphaleonis.Win32.Vss.VssRestoreTarget"/> enumeration is 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.
- </para>
- <para>
- Setting a restore target modifies or overrides the restore method set during backup (see <see cref="T:Alphaleonis.Win32.Vss.VssRestoreMethod"/>).
- </para>
+ <para>It is not known whether the writer will perform special operations during the restore operation.</para>
+ <para>This state indicates a writer error.</para>
</summary>
- <remarks>For more information see the MSDN documentation on the VSS_RESTORE_TARGET enumeration.</remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Undefined">
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterRestore.Never">
+ <summary>The writer does not require restore events.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterRestore.IfReplaceFails">
<summary>
- <para>No target is defined.</para>
- <para>This value indicates an error on the part of the writer.</para>
+ Indicates that the writer always expects to handle a <c>PreRestore</c> event, but expects to handle a
+ <c>PostRestore</c> event only if a restore fails when implementing either a
+ <see cref="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreIfNotThere"/> or
+ <see cref="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreIfCanReplace"/> restore method (<see cref="T:Alphaleonis.Win32.Vss.VssRestoreMethod"/>)
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Original">
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterRestore.Always">
+ <summary>The writer always performs special operations during the restore operation.</summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes">
<summary>
- <para>
- This is the default restore target.
- </para>
- <para>
- This value indicates that the restoration of the files included in a selected component
- (or the component set defined by that component) should proceed according to the original
- restore method specified at backup time by a <see cref="T:Alphaleonis.Win32.Vss.VssRestoreMethod"/> value.
- </para>
+ Allows additional attributes to be specified for a shadow copy. The context of a shadow copy (as set by the SetContext method in <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> method)
+ may be modified by a bitmask that contains a valid combination of <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> and
+ <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> enumeration values.
</summary>
+ <remarks>In the VSS API, these values are represented by the enumeration
+ <seealso cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> </remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Alternate">
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Persistent">
+ <summary>The shadow copy is persistent across reboots.
+ This attribute is automatically set for <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> contexts of <c>AppRollback</c>
+ <c>ClientAccessible</c>, <c>ClientAccessibleWriters</c> and <c>NasRollback</c>.
+ This attribute should not be used explicitly by requesters when setting the context of a shadow copy.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NoAutoRecovery">
<summary>
- <para>
- The files are restored to a location determined from an existing alternate location mapping.
- </para>
- <para>
- The restore target should be set to <see cref="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Alternate"/> only when
- alternate location mappings have been set for all the files managed by
- a selected component or component set.
- </para>
+ <para>Auto-recovery is disabled for the shadow copy.</para>
+ <para>A requester can modify a shadow copy context with a bitwise OR of this attribute. By doing this, the requester instructs
+ VSS to make the shadow copy read-only immediately after it is created, without allowing writers or other applications to update
+ components in the shadow copy.</para>
+ <para>Disabling auto-recovery can cause the shadow copy to be in an inconsistent state if any of its components are involved in
+ transactional database operations, such as transactional read and write operations managed by Transactional NTFS (TxF).
+ This is because disabling auto-recovery prevents incomplete transactions from being rolled back.</para>
+ <para>Disabling auto-recovery also prevents writers from excluding files from the shadow copy. </para>
+ <para><b>Windows Server 2003 and Windows XP:</b> This value is not supported until Windows Vista.</para>
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Directed">
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.ClientAccessible">
<summary>
- <para>
- Use directed targeting by the writer at restore time to restore a file.
- </para>
- <para>
- Directed targeting allows a writer to control, on a file-by-file basis, how a file is
- restored—indicating how much of a file is to be restored and into which files the backed-up file is to be restored.
- </para>
+ <para>The specified shadow copy is a client-accessible copy, supports Shadow Copies for Shared Folders, and should not be exposed. </para>
+ <para>This attribute is automatically set for <c>ClientAccessible</c> and <c>ClientAccessibleWriters</c>.</para>
+ <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.OriginalLocation">
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NoAutoRelease">
<summary>
- <para>
- The files are restored to the location at which they were at backup time, even if the original restore
- method that was specified at backup time was <see cref="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreToAlternateLocation"/>.
- </para>
- <para>
- <b>Windows Server 2003 and Windows XP:</b> This value is not supported.
- </para>
+ <para>The shadow copy is not automatically deleted when the shadow copy requester process ends.
+ The shadow copy can be deleted only by a call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DeleteSnapshot(System.Guid,System.Boolean)"/> or
+ <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DeleteSnapshotSet(System.Guid,System.Boolean)"/>.</para>
+ <para>This attribute is automatically set for <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> contexts of <c>Rollback</c>,
+ <c>ClientAccessible</c>, <c>ClientAccessibleWriters</c> and <c>Rollback</c>.</para>
</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException">
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NoWriters">
<summary>
- Exception indicating that the writer ran out of memory or other system resources.
- The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.
+ <para>No writers are involved in creating the shadow copy. </para>
+ <para>This attribute is automatically set for <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> contexts of <c>NasRollback</c>,
+ <c>FileShareBackup</c> and <c>ClientAccessible</c>.</para>
+ <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException.#ctor">
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Transportable">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException"/> class.
+ <para>The shadow copy is to be transported and therefore should not be surfaced locally. </para>
+ <para>This attribute can be used explicitly by requesters when setting the context of a shadow copy, if the provider for
+ shadow copy supports transportable shadow copies.</para>
+ <para><b>Windows Server 2003, Standard Edition, Windows Server 2003, Web Edition, and Windows XP:</b> This attribute is not supported.
+ All editions of Windows Server 2003 SP1 support this attribute.</para>
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException.#ctor(System.String)">
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NotSurfaced">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException"/> class.
+ <para>The shadow copy is not currently exposed. </para>
+ <para>Unless the shadow copy is explicitly exposed or mounted, this attribute is set for all shadow copies.</para>
+ <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
</summary>
- <param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException.#ctor(System.String,System.Exception)">
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NotTransacted">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException"/> class.
+ <para>The shadow copy is not transacted.</para>
+ <para>A requester can modify a shadow copy context with a bitwise OR of this attribute. By doing this, the requester instructs VSS to
+ disable built-in integration between VSS and transaction and resource managers.</para>
+ <para>Setting this attribute guarantees that the requester will not receive <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/> errors. However, it may
+ cause unwanted consequences, such as the loss of transactional integrity or even data loss.</para>
+ <para><b>Windows Server 2003 and Windows XP:</b> This value is not supported until Windows Vista.</para>
</summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.HardwareAssisted">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException"/> class.
+ <para>Indicates that a given provider is a hardware-based provider. </para>
+ <para>This attribute is automatically set for hardware-based providers.</para>
+ <para>This enumeration value cannot be used to manually set the context (using the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetContext(Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes)"/> method)
+ of a shadow copy by a bit mask (or bitwise OR) of this enumeration value and a valid shadow copy context value from
+ <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/>.</para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Differential">
+ <summary>
+ <para>Indicates that a given provider uses differential data or a copy-on-write mechanism to implement shadow copies. </para>
+ <para>A requester can modify a shadow copy context with a bitwise OR of this attribute. By doing this, the requester instructs providers
+ to create a shadow copy using a differential implementation. If no shadow copy provider installed on the system supports the
+ requested attributes, a <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> error will be returned to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddToSnapshotSet(System.String,System.Guid)"/>.</para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Plex">
+ <summary>
+ <para>Indicates that a given provider uses a PLEX or mirrored split mechanism to implement shadow copies. </para>
+ <para>A requester can modify a shadow copy context with a bitwise OR of this attribute. By doing this, the requester instructs the providers to create a shadow copy using a PLEX implementation. If no shadow copy provider installed on the system supports the requested
+ attributes, a <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> error will be returned to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddToSnapshotSet(System.String,System.Guid)"/>.</para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Imported">
+ <summary>
+ <para>The shadow copy of the volume was imported onto this machine using the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.ImportSnapshots"/> method
+ rather than created using the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DoSnapshotSet"/> method. </para>
+ <para>This attribute is automatically set if a shadow copy is imported.</para>
+ <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.ExposedLocally">
+ <summary>
+ <para>The shadow copy is locally exposed. If this bit flag and the <c>ExposedRemotely</c> bit flag are not set,
+ the shadow copy is hidden. </para>
+ <para>The attribute is automatically added to a shadow copy context upon calling the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.ExposeSnapshot(System.Guid,System.String,Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes,System.String)"/>
+ method to expose a shadow copy locally.</para>
+ <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.ExposedRemotely">
+ <summary>
+ <para>The shadow copy is remotely exposed. If this bit flag and the <c>ExposedLocally</c> bit flag are not set, the shadow copy is hidden. </para>
+ <para>The attribute is automatically added to a shadow copy context upon calling the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.ExposeSnapshot(System.Guid,System.String,Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes,System.String)"/>
+ method to expose a shadow copy locally.</para>
+ <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.AutoRecover">
+ <summary>
+ <para>Indicates that the writer will need to auto-recover the component in <c>CVssWriter::OnPostSnapshot</c>. </para>
+ <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.RollbackRecovery">
+ <summary>
+ <para>Indicates that the writer will need to auto-recover the component in <c>CVssWriter::OnPostSnapshot</c> if the shadow copy is being used
+ for rollback (for data mining, for example). </para>
+ <para>A requester would set this flag in the shadow copy context to indicate that the shadow copy is being created for a non-backup
+ purpose such as data mining.</para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.DelayedPostSnapshot">
+ <summary>
+ <para>Reserved for system use.</para>
+ <para><b>Windows Vista, Windows Server 2003, and Windows XP:</b> This value is not supported until Windows Server 2008.</para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.TxFRecovery">
+ <summary>
+ <para>Indicates that TxF recovery should be enforced during shadow copy creation.</para>
+ <para><b>Windows Vista, Windows Server 2003, and Windows XP:</b> This value is not supported until Windows Server 2008.</para>
+ </summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssComponentFlags">
+ <summary>
+ The <see cref="T:Alphaleonis.Win32.Vss.VssComponentFlags"/> enumeration is used by writers to indicate support for auto-recovery.
+ </summary>
+ <remarks>For more information see <see href="http://msdn.microsoft.com/en-us/library/aa384681(VS.85).aspx">MSDN documentation on VSS_COMPONENT_FLAGS Enumeration</see></remarks>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssComponentFlags.None">
+ <summary>
+ This value is reserved for operating systems that do not support the <see cref="T:Alphaleonis.Win32.Vss.VssComponentFlags"/> enumeration.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssComponentFlags.BackupRecovery">
+ <summary>
+ <para>
+ The writer will need write access to this component after the shadow copy has been created.
+ </para>
+ <para>
+ This flag is incompatible with <see cref="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Transportable"/>.
+ </para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssComponentFlags.RollbackRecovery">
+ <summary>
+ <para>
+ If this is a rollback shadow copy (<see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> enumeration value of
+ <see cref="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.RollbackRecovery"/>), the writer for this component will need
+ write access to this component after the shadow copy has been created.
+ </para>
+ <para>
+ This flag is incompatible with <see cref="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Transportable"/>.
+ </para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssComponentFlags.NotSystemState">
+ <summary>
+ <para>
+ This component is not part of system state.
+ </para>
+ <para>
+ <b>Windows Server 2003:</b> This value is not supported until Windows Vista.
+ </para>
</summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="info"/> parameter is <see langword="null"/>.
- </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">
- The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
- </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.VssWMRestoreMethod">
<summary>
@@ -315,670 +685,1451 @@ <member name="P:Alphaleonis.Win32.Vss.VssWMRestoreMethod.MappingCount">
<summary>The number of alternate mappings associated with the writer.</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor">
+ <member name="T:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType">
<summary>
- The <see cref="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor"/> class is 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).
+ <para>
+ The <see cref="T:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType"/> enumeration is used by writers to indicate their support of certain backup
+ operations—such as incremental or differential backup—on the basis of file sets (a specified file or files).
+ </para>
+ <para>
+ File sets stored in the Writer Metadata Document are tagged with a bit mask (or bitwise OR) of <see cref="T:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType"/>
+ values indicating the following:
+ <list type="bullet">
+ <item>
+ <description>
+ Whether the writer and the requester have to
+ evaluate a given file set for participation in the specified type of backup operations
+ </description>
+ </item>
+ <item>
+ <description>
+ Whether backing up the specified file will require a shadow copy
+ </description>
+ </item>
+ </list>
+ </para>
</summary>
<remarks>
- The following methods return a <see cref="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor"/> instance:
- <list type="bullet">
- <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssComponent.AlternateLocationMappings"/></description></item>
- <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssComponent.NewTargets"/></description></item>
- <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.ExcludeFiles"/></description></item>
- <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.AlternateLocationMappings"/></description></item>
- <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.Files"/></description></item>
- <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.DatabaseFiles"/></description></item>
- <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.DatabaseLogFiles"/></description></item>
- </list>
+ For more information see the MSDN documentation on
+ <see href="http://msdn.microsoft.com/en-us/library/aa384951(VS.85).aspx">VSS_FILE_SPEC_BACKUP_TYPE Enumeration</see>
</remarks>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssWMFileDescriptor.#ctor(System.String,Alphaleonis.Win32.Vss.VssFileSpecificationBackupType,System.String,System.String,System.Boolean)">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.Unknown">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor"/> class.
+ Used on operating systems where this enumeration is not supported, i.e. Windows XP.
</summary>
- <param name="alternateLocation">The alternate location.</param>
- <param name="backupTypeMask">The backup type mask.</param>
- <param name="fileSpecification">The file specification.</param>
- <param name="path">The path.</param>
- <param name="isRecursive">if set to <c>true</c> this file description is recursive.</param>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.AlternateLocation">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.FullBackupRequired">
<summary>
- Obtains the alternate backup location of the component files.
+ <para>
+ A file set tagged with this value must be involved in all types of backup operations.
+ </para>
+ <para>
+ A writer tags a file set with this value to indicate to the requester that it expects a copy of the
+ current version of the file set to be available following the restore of any backup operation
+ with a <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of
+ <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Full"/>.
+ </para>
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.BackupTypeMask">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.DifferentialBackupRequired">
<summary>
- Obtains the file backup specification for a file or set of files.
+ A writer tags a file set with this value to indicate to the requester that it
+ expects a copy of the current version of the file set to be available following
+ the restore of any backup operation with a <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of
+ <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Differential"/>.
</summary>
- <remarks><note><b>Windows XP:</b> This value is not supported in Windows XP and will always return <see cref="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.Unknown"/></note></remarks>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.FileSpecification">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.IncrementalBackupRequired">
<summary>
- Obtains the file specification for the list of files provided.
+ A writer tags a file set with this value to indicate to the requester that it
+ expects a copy of the current version of the file set to be available following the
+ restore of any backup operation with a
+ <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.Path">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.LogBackupRequired">
<summary>
- Obtains the fully qualified directory path for the list of files provided.
+ A writer tags a file set with this value to indicate to the requester that it
+ expects a copy of the current version of the file set to be available following the
+ restore of any backup operation with a
+ <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Log"/>.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.IsRecursive">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.FullSnapshotRequired">
<summary>
- Determines whether only files in the root directory or files in the entire directory hierarchy are considered for backup.
+ A file set tagged with this value must be backed up from a shadow copy of a volume
+ (and never from the original volume) when participating in a backup operation with a
+ <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Full"/>.
</summary>
- <remarks>VSS API reference: <c>IVssWMFiledesc::GetRecursive()</c></remarks>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssComponentFailure">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.DifferentialSnapshotRequired">
<summary>
- Represents a component-level error reported by writers.
+ A file set tagged with this value must be backed up from a shadow copy of a volume
+ (and never from the original volume) when participating in a backup operation with a
+ <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Differential"/>.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssComponentFailure.#ctor(System.Int32,System.Int32,System.String)">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.IncrementalSnapshotRequired">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssComponentFailure"/> class.
+ A file set tagged with this value must be backed up from a shadow copy of a volume
+ (and never from the original volume) when participating in a backup operation with a
+ <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>.
</summary>
- <param name="errorCode">The error code.</param>
- <param name="applicationErrorCode">The application error code.</param>
- <param name="applicationMessage">The application message.</param>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssComponentFailure.ErrorCode">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.LogSnapshotRequired">
<summary>
- Gets the HRESULT failure code that the writer passed for the hr parameter of the IVssComponentEx2::SetFailure method.
+ A file set tagged with this value must be backed up from a shadow copy of a volume
+ (and never from the original volume) when participating in a backup operation with a
+ <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Log"/>.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssComponentFailure.ApplicationErrorCode">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.AllBackupRequired">
<summary>
- Gets the additional error code if provided by the writer.
+ The default file backup specification type. A file set tagged with this value must always participate in backup and restore operations.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssComponentFailure.ApplicationMessage">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.AllSnapshotRequired">
<summary>
- Gets an error message for the requester to display to the end user. The writer is responsible for localizing this string if necessary before using it in this method. This parameter is optional and can be <see langword="null"/> or an empty string.
+ The shadow copy requirement for backup. A file set tagged with this value must always be backed up
+ from a shadow copy of a volume (and never from the original volume) when participating in a backup operation.
</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.Resources.LocalizedStrings">
+ <member name="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus">
<summary>
- A strongly-typed resource class, for looking up localized strings, etc.
+ The <see cref="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus"/> enumeration defines the set of statuses of a file restore operation performed on
+ the files managed by a selected component or component set.
</summary>
+ <remarks>
+ See MSDN documentation on <c>VSS_FILE_RESTORE_STATUS</c> for more information.
+ </remarks>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ResourceManager">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.Undefined">
<summary>
- Returns the cached ResourceManager instance used by this class.
+ <para>
+ The restore state is undefined.
+ </para>
+ <para>
+ This value indicates an error, or indicates that a restore operation has not yet started.
+ </para>
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.Culture">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.None">
<summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
+ <para>
+ No files were restored.
+ </para>
+ <para>
+ This value indicates an error in restoration that did not leave any restored files on disk.
+ </para>
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.AlphaVSSRequiresAtLeastWindowsXP">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.All">
<summary>
- Looks up a localized string similar to AlphaVSS requires at least Windows XP..
+ All files were restored. This value indicates success and should be set for each component that was restored successfully.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.AnotherLUNResynchronizationOperationIsAlreadyInProgress">
+ <member name="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.Failed">
<summary>
- Looks up a localized string similar to Another LUN resynchronization operation is already in progress..
+ <para>
+ The restore process failed.
+ </para>
+ <para>
+ This value indicates an error in restoration that did leave some restored files on disk. This means the components on disk are now corrupt.
+ </para>
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.AnUnexpectedErrorOccuredTheErrorCodeIsLogg">
+ <member name="T:Alphaleonis.Win32.Vss.VssUtils">
<summary>
- Looks up a localized string similar to An unexpected error occurred. The error code is logged in the error log file..
+ The <see cref="T:Alphaleonis.Win32.Vss.VssUtils"/> class is a static utility class for accessing the platform specific
+ instances of the various VSS interfaces in a platform-independent manner.
</summary>
+ <remarks>
+ Use the <see cref="M:Alphaleonis.Win32.Vss.VssUtils.LoadImplementation"/> under normal circumstances to load
+ the correct assembly and create an instance of <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> from that assembly. If you have
+ specific requirements on how the assembly should be loaded, or the instance created you are not required to use
+ these methods but can use the methods in this class for accessing the suggested assembly name to load, and load it manually.
+ In this case you need to create an instance of the class called <c>Alphaleonis.Win32.Vss.VssImplementation</c> from the platform specific
+ assembly. This class implements the <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> interface, and has a public parameterless constructor.
+ </remarks>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.AnUnexpectedErrorOccurredDuringCommunicationWithWriters">
+ <member name="M:Alphaleonis.Win32.Vss.VssUtils.GetPlatformSpecificAssemblyShortName">
<summary>
- Looks up a localized string similar to An unexpected error occurred during communication with writers..
+ Gets the short name of the platform specific assembly for the platform on which the assembly
+ is currently executing.
</summary>
+ <returns>the short name of the platform specific assembly for the platform on which the assembly
+ is currently executing.</returns>
+ <exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The operating system could not be detected or is unsupported.</exception>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.DeletionOfSnapshotFailedSeeInnerExceptionF">
+ <member name="M:Alphaleonis.Win32.Vss.VssUtils.GetPlatformSpecificAssemblyName">
<summary>
- Looks up a localized string similar to Deletion of snapshot failed. See inner exception for details. .
+ Gets the full name of the platform specific assembly for the platform on which the assembly is currently executing.
</summary>
+ <returns>The full name of the platform specific assembly for the platform on which the assembly is currently executing.</returns>
+ <exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The operating system could not be detected or is unsupported.</exception>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.DeletionOfSnapshotsFailed">
+ <member name="M:Alphaleonis.Win32.Vss.VssUtils.LoadImplementation">
<summary>
- Looks up a localized string similar to Deletion of snapshots failed.
+ Loads the assembly containing the correct implementation of the <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> interface
+ for the operating system on which the assembly is currently executing.
</summary>
+ <overloads>
+ Loads the assembly containing the correct implementation of the <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> interface
+ for the operating system on which the assembly is currently executing, optionally allowing the specification
+ of an <see cref="T:System.AppDomain"/> into which to load the assembly.
+ </overloads>
+ <remarks>
+ <para>
+ The assembly will be loaded into the same <see cref="T:System.AppDomain"/> as the calling assembly.
+ </para>
+ <para>
+ The assemblies are loaded using strong name lookup. They need to be present in the code base directory
+ of the executing assembly, or installed in the GAC for the lookup to succeed.
+ </para>
+ </remarks>
+
+ <returns>An newly created instance of <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> suitable for the
+ operating system on which the assembly is currently executing.</returns>
+ <exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The operating system could not be detected or is unsupported.</exception>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ExpectedProviderError">
+ <member name="T:Alphaleonis.Win32.Vss.VssRebootRequiredException">
<summary>
- Looks up a localized string similar to Expected provider error. Check the event log for details..
+ <para>Exception thrown to indicate that the provider encountered an error that requires the user to restart the computer.</para>
</summary>
+ <remarks>
+ <note><b>Windows Server 2003 and Windows XP:</b>This exception is not supported until Windows Vista.</note>
+ </remarks>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.FailedToDetectArchitectureOfRunningOperati">
+ <member name="M:Alphaleonis.Win32.Vss.VssRebootRequiredException.#ctor">
<summary>
- Looks up a localized string similar to Failed to detect architecture of running operating system..
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException"/>
+ class with a system-supplied message describing the error.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.IA64ArchitectureIsNotSupported">
+ <member name="M:Alphaleonis.Win32.Vss.VssRebootRequiredException.#ctor(System.String)">
<summary>
- Looks up a localized string similar to IA64 architecture is not supported..
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException"/> class with a specified error message.
</summary>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.InvalidXMLDocumentCheckTheEventLogForDetails">
+ <member name="M:Alphaleonis.Win32.Vss.VssRebootRequiredException.#ctor(System.String,System.Exception)">
<summary>
- Looks up a localized string similar to Invalid XML document. Check the event log for details..
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.MaximumDiffAreaAssociationsReached">
+ <member name="M:Alphaleonis.Win32.Vss.VssRebootRequiredException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- Looks up a localized string similar to The maximum number of shadow copy storage areas has been added to the shadow copy source volume..
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException"/> class.
</summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.RequestedOperationUnsupportedByOS">
+ <member name="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException">
<summary>
- Looks up a localized string similar to The requested operation is not supported on the current operating system..
+ Exception thrown to indicate that the volume has been added to the maximum number of shadow copy sets.
+ The specified volume was not added to the shadow copy set.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.SystemWasUnableToFreezeDtcOrKtm">
+ <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException.#ctor">
<summary>
- Looks up a localized string similar to System was unable to freeze the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException"/>
+ class with a system-supplied message describing the error.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheCreationOfAShadowCopyIsAlreadyInProgress">
+ <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException.#ctor(System.String)">
<summary>
- Looks up a localized string similar to The creation of a shadow copy is already in progress..
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException"/> class with a specified error message.
</summary>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheMaximumNumberOfVolumesHasAlreadyBeenAddedToTheShadowCopySet">
+ <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException.#ctor(System.String,System.Exception)">
<summary>
- Looks up a localized string similar to The maximum number of volumes has already been added to the shadow copy set..
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheOperationIsNotSupportedUnderTheCurrentContext">
+ <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- Looks up a localized string similar to The operation is not supported under the current context..
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException"/> class.
</summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheProviderEncounteredAnErrorThatRequiresTheUserToRestartTheComputer">
+ <member name="T:Alphaleonis.Win32.Vss.VssSnapshotCompatibility">
<summary>
- Looks up a localized string similar to The provider encountered an error that requires the user to restart the computer..
+ The <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotCompatibility"/> enumeration indicates which volume control or file I/O operations are disabled for the
+ volume that has been shadow copied.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotCompatibility.None">
+ <summary>None of the other flags.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotCompatibility.DisableDefrag">
+ <summary>The provider managing the shadow copies for a specified volume does not support defragmentation operations on that volume.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotCompatibility.DisableContentIndex">
+ <summary>The provider managing the shadow copies for a specified volume does not support content index operations on that volume.</summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssError">
+ <summary>
+ <para>
+ The <see cref="T:Alphaleonis.Win32.Vss.VssError"/> enumeration represents error- and success codes that may be
+ returned by some Vss methods.
+ </para>
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheProviderReturnedAnUnexpectedErrorCode">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.Success">
+ <summary>Indication of a successful operation.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.AsyncCanceled">
<summary>
- Looks up a localized string similar to The provider returned an unexpected error code..
+ The asynchronous operation was cancelled.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheRequestedIdentifierDoesNotCorrespondToARegisteredProvider">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.AsyncFinished">
<summary>
- Looks up a localized string similar to The requested identifier does not correspond to a registered provider..
+ The asynchronous operation was completed successfully.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheRequestedObjectDoesNotExist">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.AsyncPending">
<summary>
- Looks up a localized string similar to The requested object does not exist..
+ The asynchronous operation is still running.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheRequestedObjectWasADuplicate">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.Unexpected">
<summary>
- Looks up a localized string similar to The requested object was a duplicate..
+ Unexpected error. The error code is logged in the error log file.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheSystemOrProviderHasInsufficientStorageSpace">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.BadState">
<summary>
- Looks up a localized string similar to The system or provider has insufficient storage space. If possible delete any old or unnecessary persistent shadow copies and try again..
+ A method call was made when the object was in an incorrect state
+ for that method.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheSystemWasUnableToFlushIOWrites">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.ProviderAlreadyRegistered">
<summary>
- Looks up a localized string similar to The system was unable to flush I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times..
+ The provider has already been registered.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheSystemWasUnableToHoldIOWrites">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.ProviderNotRegistered">
<summary>
- Looks up a localized string similar to The system was unable to hold I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
+ The specified identifier does not correspond to a registered provider.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeAlreadyHasARevertInProgress">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.ProviderVeto">
<summary>
- Looks up a localized string similar to The volume already has a revert in progress..
+ The provider was unable to perform the request at this time. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeDoesNotSupportTheRequestedOperation">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.ProviderInUse">
<summary>
- Looks up a localized string similar to The volume does not support the requested operation, or no provider supports it..
+ The shadow copy provider is currently in use and cannot be unregistered.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeHasAlreadyBeenAddedToTheMaximumNumberOfShadowCopySets">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.ObjectNotFound">
<summary>
- Looks up a localized string similar to The volume has already been added to the maximum number of shadow copy sets..
+ The specified object was not found.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeIsNotSupportedByTheSpecifiedProvider">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.VolumeNotSupported">
<summary>
- Looks up a localized string similar to The volume is not supported by the specified provider..
+ No VSS provider indicates that it supports the specified volume.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeWasInUseAndCouldNotBeLocked">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.VolumeNotSupportedByProvider">
<summary>
- Looks up a localized string similar to The volume was in use and could not be locked..
+ The volume is not supported by the specified provider.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVSSObjectWasInAnIncorrectStateForTheRequestedOperation">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.ObjectAlreadyExists">
<summary>
- Looks up a localized string similar to The VSS object was in an incorrect state for the requested operation..
+ The object already exists.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheWriterInfrastructureIsNotOperatingProperly">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.UnexpectedProviderError">
<summary>
- Looks up a localized string similar to The writer infrastructure is not operating properly. Check that the Event Service and VSS have been started, and check for errors associated with those services in the error log..
+ The provider returned an unexpected error code. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheWriterIsNotResponding">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.InvalidXmlDocument">
<summary>
- Looks up a localized string similar to The writer is not responding..
+ The given XML document is invalid. It is either incorrectly-formed XML or it does not match the schema.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires01DetectedOperatingSystemWas23">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.MaximumNumberOfVolumesReached">
<summary>
- Looks up a localized string similar to This operation requires {0}{1}. Detected operating system was: {2}{3}..
+ The maximum number of volumes has been added to the shadow copy set. The specified volume was not added to the shadow copy set.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires01OrLaterDetectedOperatingSystemWas23">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.UnexpectedWriterError">
<summary>
- Looks up a localized string similar to This operation requires {0}{1} or later. Detected operating system was: {2}{3}..
+ VSS encountered problems while sending events to writers.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires0DetectedOperatingSystemWas1">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.SnapshotSetInProgress">
<summary>
- Looks up a localized string similar to This operation requires {0}. Detected operating system was: {1}..
+ Another shadow copy creation is already in progress. Please wait a few moments and try again.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.MaximumNumberOfSnapshotsReached">
+ <summary>
+ The volume has been added to the maximum number of shadow copy sets. The specified volume was not added to the shadow copy set.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires0OrLaterDetectedOperatingSystemWas1">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.WriterInfrastructureError">
<summary>
- Looks up a localized string similar to This operation requires {0} or later. Detected operating system was: {1}..
+ An error was detected in the Volume Shadow Copy Service (VSS). The problem occurred while trying to contact VSS writers.
+ Please verify that the Event System service and the VSS service are running and check for associated errors in the event logs.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires0WithAtLeastServicePack1DetectedOperatingSystemWas23">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.WriterNotResponding">
<summary>
- Looks up a localized string similar to This operation requires {0} with at least Service Pack {1}. Detected operating system was: {2}{3}..
+ A writer did not respond to a GatherWriterStatus call. The writer may either have terminated
+ or it may be stuck. Check the system and application event logs for more information.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires0WithAtLeastServicePack1Or2WithAtLeastServicePack3DetectedOperatingSystemWas45">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.WriterAlreadySubscribed">
<summary>
- Looks up a localized string similar to This operation requires {0} with at least Service Pack {1}, or {2} with at least service pack {3}. Detected operating system was: {4}{5}..
+ The writer has already sucessfully called the Subscribe function. It cannot call
+ subscribe multiple times.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisVersionOfTheHardwareProviderDoesNotSupportThisOperation">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.UnsupportedContext">
<summary>
- Looks up a localized string similar to This version of the hardware provider does not support this operation..
+ The shadow copy provider does not support the specified shadow copy type.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.UnexpectedSystemError">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.VolumeInUse">
<summary>
- Looks up a localized string similar to Unexpected system error..
+ The specified shadow copy storage association is in use and so can't be deleted.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.UnsupportedOperatingSystemExceptionMessage">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.MaximumDiffareaAssociationsReached">
<summary>
- Looks up a localized string similar to The requested method is not supported on the current operating system, or the loaded assembly is targeted for a different operating system than the one on which it is running..
+ Maximum number of shadow copy storage associations already reached.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssCannotRevertDiskIdExceptionMessage">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.InsufficientStorage">
<summary>
- Looks up a localized string similar to The MBR signature or GPT ID for one or more disks could not be set to the intended value. Check the Application event log for more information..
+ The system or provider has insufficient storage space. If possible delete any old or unnecessary persistent shadow copies and try again.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssInconsistentSnapshotWriterExceptionMessage">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.NoSnapshotsImported">
<summary>
- Looks up a localized string similar to The shadow copy contains only a subset of the volumes needed by the writer to correctly back up the application component..
+ No shadow copies were successfully imported.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssNonRetryableWriterExceptionMessage">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.SomeSnapshotsNotImportedSuccess">
<summary>
- Looks up a localized string similar to The writer operation failed because of an error that might recur if another shadow copy is created..
+ Some shadow copies were not succesfully imported.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssOutOfResourcesExceptionMessage">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.SomeSnapshotsNotImportedError">
<summary>
- Looks up a localized string similar to The writer ran out of memory or other system resources..
+ Some shadow copies were not succesfully imported.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssPartialFailureWriterExceptionMessage">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.MaximumNumberOfRemoteMachinesReached">
<summary>
- Looks up a localized string similar to The writer is reporting one or more component-level errors..
+ The maximum number of remote machines for this operation has been reached.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssRetryableWriterExceptionMessage">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.RemoteServerUnavailable">
<summary>
- Looks up a localized string similar to The writer failed due to an error that would likely not occur if the entire backup, restore, or shadow copy creation process was restarted.
+ The remote server is unavailable.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssSnapshotNotInSetExceptionMessage">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.RemoteServerUnsupported">
<summary>
- Looks up a localized string similar to The specified snapshot specifies a shadow copy that does not exist in the Backup Components Document..
+ The remote server is running a version of the Volume Shadow Copy Service that does not
+ support remote shadow-copy creation.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssTimeoutWriterExceptionMessage">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.RevertInProgress">
<summary>
- Looks up a localized string similar to The writer operation failed because of a time-out between the Freeze and Thaw events..
+ A revert is currently in progress for the specified volume. Another revert
+ cannot be initiated until the current revert completes.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssUnselectedVolumeExceptionMessage">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.RevertVolumeLost">
<summary>
- Looks up a localized string similar to The resynchronization destination contained a volume that was not explicitly included..
+ The volume being reverted was lost during revert.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssWriterStatusNotAvailableExceptionMessage">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.RebootRequired">
<summary>
- Looks up a localized string similar to Writer status is not available for one or more writers. A writer may have reached the maximum number of available backup and restore sessions..
+ <para>The provider encountered an error that requires the user to restart the computer.</para>
+ <para><b>Windows Server 2003 and Windows XP:</b>This value is not supported until Windows Vista.</para>
</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssUnexpectedErrorException">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.TransactionFreezeTimeout">
<summary>
- Exception class indicating that an unexpected error occured. The error code is logged in the error log file.
+ <para>The system was unable to freeze the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).</para>
+ <para><b>Windows Server 2003 and Windows XP:</b>This value is not supported until Windows Vista.</para>
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedErrorException.#ctor">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.TransactionThawTimeout">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssException"/> class.
+ <para>The system was unable to thaw the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).</para>
+ <para><b>Windows Server 2003 and Windows XP:</b>This value is not supported until Windows Vista.</para>
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedErrorException.#ctor(System.String)">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.WriterErrorInconsistentSnapshot">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedErrorException"/> class with the specified error message.
+ The shadow copy contains only a subset of the volumes needed by the writer to correctly back
+ up the application component.
</summary>
- <param name="message">The error message.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedErrorException.#ctor(System.String,System.Exception)">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.WriterOutOfResources">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedErrorException"/> class with the specified error message
- and a reference to the inner exception that is the cause of this exception.
+ The writer ran out of memory or other system resources. The recommended way to handle this error code is
+ to wait ten minutes and then repeat the operation, up to three times.
</summary>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedErrorException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="F:Alphaleonis.Win32.Vss.VssError.WriterTimeout">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedErrorException"/> class with serialized data.
+ The writer operation failed because of a time-out between the Freeze and Thaw events.
+ The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.
</summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssWriterState">
- <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssWriterState"/> enumeration indicates the current state of the writer.</summary>
- <remarks>A requester determines the state of a writer through <see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterStatus"/>.</remarks>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.WriterErrorRetryable">
+ <summary>
+ The writer failed due to an error that would likely not occur if the entire backup, restore, or shadow copy creation
+ process was restarted. The recommended way to handle this error code is to wait ten minutes and then repeat
+ the operation, up to three times.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.Unknown">
- <summary><para>The writer's state is not known.</para><para>This indicates an error on the part of the writer.</para></summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.WriterErrorNonRetryable">
+ <summary>
+ The writer experienced a non-transient error. If the backup process is retried,
+ the error is likely to reoccur.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.Stable">
- <summary>The writer has completed processing current shadow copy events and is ready to proceed, or <c>CVssWriter::OnPrepareSnapshot</c> has not yet been called.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.WriterErrorRecoveryFailed">
+ <summary>
+ The writer experienced an error while trying to recover the shadow-copy volume.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.WaitingForFreeze">
- <summary>The writer is waiting for the freeze state.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.BreakRevertIdFailed">
+ <summary>
+ The shadow copy set break operation failed because the disk/partition identities could not be reverted.
+ The target identity already exists on the machine or cluster and must be masked before this operation can succeed.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.WaitingForThaw">
- <summary>The writer is waiting for the thaw state.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.LegacyProvider">
+ <summary>
+ This version of the hardware provider does not support this operation.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.WaitingForPostSnapshot">
- <summary>The writer is waiting for the <c>PostSnapshot</c> state.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.BreakFailFromProvider">
+ <summary>
+ At least one of the providers in this Shadow Copy Set failed the break operation for a snapshot.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.WaitingForBackupComplete">
- <summary>The writer is waiting for the requester to finish its backup operation.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.AsrDiskAssignmentFailed">
+ <summary>
+ There are too few disks on this computer or one or more of the disks is too small.
+ Add or change disks so they match the disks in the backup, and try the restore again.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtIdentify">
- <summary>The writer vetoed the shadow copy creation process at the writer identification state.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.AsrDiskRecreationFailed">
+ <summary>
+ Windows cannot create a disk on this computer needed to restore from the backup.
+ Make sure the disks are properly connected, or add or change disks, and try the restore again.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPrepareBackup">
- <summary>The writer vetoed the shadow copy creation process during the backup preparation state.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.AsrNoArcPath">
+ <summary>
+ The computer needs to be restarted to finish preparing a hard disk for restore. To continue, restart your computer and run the restore again.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPrepareSnapshot">
- <summary>The writer vetoed the shadow copy creation process during the <c>PrepareForSnapshot</c> state.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.AsrMissingDynamicDisk">
+ <summary>
+ The backup failed due to a missing disk for a dynamic volume. Please ensure the disk is online and retry the backup.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtFreeze">
- <summary>The writer vetoed the shadow copy creation process during the freeze state.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.AsrSharedCriticalDiskError">
+ <summary>
+ Automated System Recovery failed the shadow copy, because a selected critical volume is located on a cluster shared disk.
+ This is an unsupported configuration.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtThaw">
- <summary>The writer vetoed the shadow copy creation process during the thaw state.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.AsrDatadiskRdisk0">
+ <summary>
+ A data disk is currently set as active in BIOS. Set some other disk as active or use the DiskPart utility to clean the
+ data disk, and then retry the restore operation.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPostSnapshot">
- <summary>The writer vetoed the shadow copy creation process during the <c>PostSnapshot</c> state.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.AsrRdisk0TooSmall">
+ <summary>
+ The disk that is set as active in BIOS is too small to recover the original system disk.
+ Replace the disk with a larger one and retry the restore operation.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtBackupComplete">
- <summary>The shadow copy has been created and the writer failed during the <c>BackupComplete</c> state.
- A writer should save information about this failure to the error log.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.AsrCriticalDisksTooSmall">
+ <summary>
+ There is not enough disk space on the system to perform the restore operation.
+ Add another disk or replace one of the existing disks and retry the restore operation.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPreRestore">
- <summary>The writer failed during the <c>PreRestore</c> state.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.WriterStatusNotAvailable">
+ <summary>
+ <para>
+ The writer status is not available for one or more writers. A writer may have reached the maximum number of available backup
+ and restore sessions.
+ </para>
+ <para>
+ <b>Windows Vista, Windows Server 2003, and Windows XP:</b> This value is not supported.
+ </para>
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPostRestore">
- <summary>The writer failed during the <c>PostRestore</c> state.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.FlushWritesTimeout">
+ <summary>
+ The system was unable to flush I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtBackupShutdown">
- <summary>The writer failed during the shutdown of the backup application.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssError.HoldWritesTimeout">
+ <summary>
+ The system was unable to hold I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
+ </summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssBackupSchema">
- <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssBackupSchema"/> enumeration is used by a writer to indicate the types of backup operations it can participate in.
- The supported kinds of backup are expressed as a bit mask (or bitwise OR) of <see cref="T:Alphaleonis.Win32.Vss.VssBackupSchema"/> values.</summary>
+ <member name="T:Alphaleonis.Win32.Vss.VssWriterStatusInfo">
+ <summary>
+ Represenation of the status for a specific writer.
+ </summary>
+ <remarks>This class acts as a container for the information returned from
+ <see href="http://msdn.microsoft.com/en-us/library/aa382680(VS.85).aspx">IVssBackupComponents.GetWriterStatus</see> in the original
+ VSS API</remarks>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterStatusInfo.#ctor(System.Guid,System.Guid,System.String,Alphaleonis.Win32.Vss.VssWriterState,Alphaleonis.Win32.Vss.VssError,System.Nullable{System.Int32},System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusInfo"/> class.
+ </summary>
+ <param name="instanceId">The writer instance id.</param>
+ <param name="writerClassId">The writer class id.</param>
+ <param name="writerName">Name of the writer.</param>
+ <param name="state">The state.</param>
+ <param name="failure">The failure.</param>
+ <param name="applicationErrorCode">The application error code.</param>
+ <param name="applicationErrorMessage">The application error message.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterStatusInfo.#ctor(System.Guid,System.Guid,System.String,Alphaleonis.Win32.Vss.VssWriterState,Alphaleonis.Win32.Vss.VssError)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusInfo"/> class.
+ </summary>
+ <param name="instanceId">The writer instance id.</param>
+ <param name="writerId">The writer class id.</param>
+ <param name="writerName">Name of the writer.</param>
+ <param name="state">The state.</param>
+ <param name="failure">The failure.</param>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.InstanceId">
+ <summary>
+ The instance id of the writer.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.ClassId">
+ <summary>
+ The identifier of the writer class.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.Name">
+ <summary>
+ The name of the writer.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.State">
+ <summary>
+ A <see cref="T:Alphaleonis.Win32.Vss.VssWriterState"/> value containing the state of the writer.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.Failure">
+ <summary>
+ A <see cref="T:Alphaleonis.Win32.Vss.VssError"/> value indicating the failure code (if any) of the writer.
+ </summary>
<remarks>
<para>
- <note>
- <b>Windows XP:</b> This enumeration is not available until Windows Server 2003 or later.
- </note>
- </para>
- <para>
- Writer set their backup schemas with calls to <c>IVssCreateWriterMetadata.SetBackupSchema"</c>.
- </para>
- <para>
- Requesters use <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.BackupSchema"/> to determine the backup schema that a writer supports.
- </para>
- <para>
- For a specific kind of backup operation to be supported, the writer must support the corresponding schema, and the
- requester must set the corresponding backup type.
- </para>
- <para>
- For example, to involve a writer in an incremental backup operation, the requester must set the backup type to
- <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>, and the writer should have a backup schema that includes <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental"/>.
- </para>
- <para>
- A writer that does not support the backup schema corresponding to a requester's backup type should treat the backup operation
- that is being performed as if it were a default (full) backup. If the desired backup type is not supported by the writer's
- backup schema, the requester can either perform a full backup for this writer or exclude the writer from the backup operation.
- A requester can exclude a writer by selecting none of the writer's components, or by disabling the writer
- (see <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DisableWriterClasses(System.Guid[])"/> or
- <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DisableWriterInstances(System.Guid[])"/>).
+ The following are the supported values for <see cref="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.Failure"/>:
+ <list type="table">
+ <listheader>
+ <term>Value</term>
+ <description>Meaning</description>
+ </listheader>
+ <item>
+ <term><see cref="F:Alphaleonis.Win32.Vss.VssError.Success"/></term>
+ <description>The writer was successful.</description>
+ </item>
+ <item>
+ <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterErrorInconsistentSnapshot"/></term>
+ <description>The shadow copy contains only a subset of the volumes needed by the writer to correctly back up the application component.</description>
+ </item>
+ <item>
+ <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterOutOfResources"/></term>
+ <description>The writer ran out of memory or other system resources. The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.</description>
+ </item>
+ <item>
+ <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterTimeout"/></term>
+ <description>The writer operation failed because of a time-out between the Freeze and Thaw events. The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.</description>
+ </item>
+ <item>
+ <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterErrorRetryable"/></term>
+ <description>The writer failed due to an error that would likely not occur if the entire backup, restore, or shadow copy creation process was restarted. The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.</description>
+ </item>
+ <item>
+ <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterErrorNonRetryable"/></term>
+ <description>The writer operation failed because of an error that might recur if another shadow copy is created.</description>
+ </item>
+ <item>
+ <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterNotResponding"/></term>
+ <description>The writer is not responding.</description>
+ </item>
+ <item>
+ <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterStatusNotAvailable"/></term>
+ <description>
+ <para>
+ The writer status is not available for one or more writers. A writer may have reached the maximum number of available backup and restore sessions.
+ </para>
+ <para>
+ <b>Windows Vista, Windows Server 2003 and Windows XP:</b> This value is not supported.
+ </para>
+ </description>
+ </item>
+ </list>
</para>
</remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Undefined">
+ <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.ApplicationErrorCode">
<summary>
- The writer supports a simple full backup and restoration of entire files (as defined by a <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> value of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Full"/>).
- This backup scheme can be used as the basis of an incremental or differential backup. This is the default value.
+ Gets the return code that the writer passed for the <c>hrApplication</c> parameter of the <c>CVssWriterEx2::SetWriterFailureEx</c> method.
</summary>
+ <remarks>
+ <note>This property requires Windows 7 or Windows Server 2008 R2 and will be <see langword="null"/> on earlier operating systems.</note>
+ </remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Differential">
+ <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.ApplicationErrorMessage">
<summary>
- The writer supports differential backups (corresponding to the <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> value <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Differential"/>).
- Files created or changed since the last full backup are saved. Files are not marked as having been backed up. This setting does not preclude mixing of incremental and differential backups.
+ Gets the application failure message that the writer passed for the <c>wszApplicationMessage</c> parameter of the <c>SetWriterFailureEx</c> method.
</summary>
+ <remarks>
+ <note>This property requires Windows 7 or Windows Server 2008 R2 and will be <see langword="null"/> on earlier operating systems.</note>
+ </remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental">
+ <member name="T:Alphaleonis.Win32.Vss.VssProtectionLevel">
<summary>
- The writer supports incremental backups (corresponding to the <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> value <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>). Files created or changed since the last full or incremental backup are saved. Files are marked as having been backed up. This setting does not preclude mixing of incremental and differential backups.
+ Defines the set of volume shadow copy protection levels.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.ExclusiveIncrementalDifferential">
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionLevel.OriginalVolume">
<summary>
- The writer supports both differential and incremental backup schemas, but only exclusively: for example, you cannot follow a differential backup with an incremental one.
- A writer cannot support this schema if it does not support both incremental and differential schemas (<see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Differential"/> | <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental"/>).
+ Specifies that I/O to the original volume must be maintained at the expense of shadow copies.
+ This is the default protection level. Shadow copies might be deleted if both of the following conditions occur:
+ <list type="bullet">
+ <item>
+ <description>
+ A write to the original volume occurs.
+ </description>
+ </item>
+ <item>
+ <description>
+ The integrity of the shadow copy cannot be maintained for some reason, such as a failure to
+ write to the shadow copy storage area or a failure to allocate sufficient memory.
+ </description>
+ </item>
+ </list>
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Log">
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionLevel.Snapshot">
<summary>
- <para>The writer supports backups that involve only the log files it manages (corresponding to a <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> value of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Log"/>). </para>
+ Specifies that shadow copies must be maintained at the expense of I/O to the original volume.
+ All I/O to the original volume will fail if both of the following conditions occur:
+ <list type="bullet">
+ <item>
+ <description>
+ A write to the original volume occurs.
+ </description>
+ </item>
+ <item>
+ <description>
+ The corresponding write to the shadow copy storage area cannot be completed for some reason,
+ such as a failure to write to the shadow copy storage area or a failure to allocate sufficient memory.
+ </description>
+ </item>
+ </list>
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Copy">
+ <member name="T:Alphaleonis.Win32.Vss.VssHardwareOptions">
<summary>
- Similar to the default backup schema (<see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Undefined"/>), the writer supports copy backup operations
- (corresponding to <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Copy"/>) where file access information (such as information as to when a file was
- last backed up) will not be updated either in the writer's own state information or in the file system information. This type of
- backup cannot be used as the basis of an incremental or differential backup.
+ Defines shadow copy LUN flags.
</summary>
+ <remarks>
+ Only supported on Windows Server 2008.
+ </remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Timestamped">
- <summary>
- <para>
- A writer supports using the VSS time-stamp mechanism when evaluating if a file should be included in
- differential or incremental operations (corresponding to <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Differential"/> and
- <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>, respectively) using the <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.PreviousBackupStamp"/>,
- <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.BackupStamp"/> setters, and the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetPreviousBackupStamp(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/> method.
- </para>
- <para>
- A writer cannot support this schema if it does not support either differential or incremental backup schemas
- (<see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Differential"/> or <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental"/>).
- </para>
-
- </summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.MaskLuns">
+ <summary>
+ The shadow copy LUN will be masked from the host.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.LastModify">
+ <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.MakeReadWrite">
<summary>
+ The shadow copy LUN will be exposed to the host as a read-write volume.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.RevertIdentityAll">
+ <summary>
+ The disk identifiers of all of the shadow copy LUNs will be reverted to that of the
+ original LUNs. However, if any of the original LUNs are present on the system, the operation will
+ fail and none of the identifiers will be reverted.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.RevertIdentityNone">
+ <summary>
+ None of the disk identifiers of the shadow copy LUNs will be reverted.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.OnLunStateChangeNotifyReadWrite">
+ <summary>
+ The shadow copy LUNs will be converted permanently to read-write.
+ This flag is set only as a notification for the provider; no provider action is required.
+ For more information, see the <c>IVssHardwareSnapshotProviderEx::OnLunStateChange</c> method.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.OnLunStateChangeNotifyLunPreRecovery">
+ <summary>
+ The shadow copy LUNs will be converted temporarily to read-write and are about to undergo TxF recovery
+ or VSS auto-recovery. This flag is set only as a notification for the provider; no provider action is required.
+ For more information, see the <c>IVssHardwareSnapshotProviderEx::OnLunStateChange method</c>.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.OnLunStateChangeNotifyLunPostRecovery">
+ <summary>
+ The shadow copy LUNs have just undergone TxF recovery or VSS auto-recovery and have been converted back to
+ read-only. This flag is set only as a notification for the provider; no provider action is required.
+ For more information, see the <c>IVssHardwareSnapshotProviderEx::OnLunStateChange method</c>.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.OnLunStateChangeDoMaskLuns">
+ <summary>
+ The provider must mask shadow copy LUNs from this computer.
+ For more information, see the <c>IVssHardwareSnapshotProviderEx::OnLunStateChange method</c>.
+ </summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.IVssSnapshotManagement">
+ <summary>
+ The <see cref="T:Alphaleonis.Win32.Vss.IVssSnapshotManagement"/> interface provides a method that returns an interface to further configure a shadow copy provider.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.IVssSnapshotManagement.GetDifferentialSoftwareSnapshotManagementInterface">
+ <summary>
+ Gets an instance of the differential software snapshot management interface to further configure the system provider.
+ </summary>
+ <remarks>
<para>
- When implementing incremental or differential backups with differenced files, a writer can provide last modification
- time information for files (using <c>IVssComponent.AddDifferencedFileByLastModifyTime</c>).
- A requester then can use <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.DifferencedFiles"/> to obtain candidate files and information
- about their last modification data. The requester can use this information (along with any records about
- previous backup operations it maintains) to decide if a file should be included in incremental and differential backups.
+ <note>
+ <para>
+ <b>Windows XP:</b> This method is not supported until Windows 2003.
+ </para>
+ </note>
</para>
+ </remarks>
+ <returns>An instance of the differential software snapshot management interface to further configure the system provider.</returns>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.IVssSnapshotManagement.GetMinDiffAreaSize">
+ <summary>
+ Returns the current minimum size of the shadow copy storage area.
+ </summary>
+ <remarks>
<para>
- This scheme does not apply to partial file implementations of incremental and differential backup operations.
+ The shadow copy storage area minimum size is a per-computer setting. Prior to Windows Server 2003 Service Pack 1 (SP1), this
+ was fixed at 100 MB. With Windows Server 2003 SP1, the shadow copy storage area has a minimum size of 300 MB and can be
+ increased in 300 MB increments up to 3000 MB (3 GB). This setting is stored in the <c>MinDiffAreaFileSize</c> value of type
+ <c>REG_DWORD</c> in <c>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\VolSnap</c> (the value is the size, in MB).
</para>
<para>
- A writer cannot support this schema if it does not support either incremental or differential backup
- schemas (<see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Differential"/> or <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental"/>.
+ <note>
+ <para>
+ <b>Windows XP and Windows 2003:</b> This method is not supported until Windows 2003 SP1.
+ </para>
+ </note>
</para>
+ </remarks>
+ <returns>The current minimum size of the shadow copy storage area.</returns>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">
+ <summary>
+ Exception thrown to indicate that the requested object did not exists.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Lsn">
+ <member name="M:Alphaleonis.Win32.Vss.VssObjectNotFoundException.#ctor">
<summary>
- Reserved for system use.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"/>
+ class with a system-supplied message describing the error.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.WriterSupportsNewTarget">
+ <member name="M:Alphaleonis.Win32.Vss.VssObjectNotFoundException.#ctor(System.String)">
<summary>
- The writer supports a requester changing the target for file restoration using
- <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddNewTarget(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String,System.String,System.Boolean,System.String)"/>.
- </summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"/> class with a specified error message.
+ </summary>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.WriterSupportsRestoreWithMove">
+ <member name="M:Alphaleonis.Win32.Vss.VssObjectNotFoundException.#ctor(System.String,System.Exception)">
<summary>
- <para>
- The writer supports running multiple writer instances with the same class ID, and it supports a
- requester moving a component to a different writer instance at restore time using
- <see cref="O:Alphaleonis.Win32.Vss.IVssBackupComponents.SetSelectedForRestore"/>.
- </para>
- <para>
- <b>Windows Server 2003:</b> This value is not supported until Windows Server 2003 SP1.
- </para>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.IndependentSystemState">
+ <member name="M:Alphaleonis.Win32.Vss.VssObjectNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException">
+ <summary>
+ Exception thrown to indicate The system was unable to flush I/O writes.
+ </summary>
+ <remarks>
+ This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
+ </remarks>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException"/>
+ class with a system-supplied message describing the error.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException"/> class with a specified error message.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException">
+ <summary>
+ Exception indicating that the resynchronization destination contained a volume that was not explicitly included.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssUnselectedVolumeException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException"/> class.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssUnselectedVolumeException.#ctor(System.String)">
<summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException"/> class.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssUnselectedVolumeException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException"/> class.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssUnselectedVolumeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">
+ The <paramref name="info"/> parameter is <see langword="null"/>.
+ </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">
+ The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
+ </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssRestoreTarget">
+ <summary>
+ <para>
+ The <see cref="T:Alphaleonis.Win32.Vss.VssRestoreTarget"/> enumeration is 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.
+ </para>
+ <para>
+ Setting a restore target modifies or overrides the restore method set during backup (see <see cref="T:Alphaleonis.Win32.Vss.VssRestoreMethod"/>).
+ </para>
+ </summary>
+ <remarks>For more information see the MSDN documentation on the VSS_RESTORE_TARGET enumeration.</remarks>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Undefined">
+ <summary>
+ <para>No target is defined.</para>
+ <para>This value indicates an error on the part of the writer.</para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Original">
+ <summary>
+ <para>
+ This is the default restore target.
+ </para>
+ <para>
+ This value indicates that the restoration of the files included in a selected component
+ (or the component set defined by that component) should proceed according to the original
+ restore method specified at backup time by a <see cref="T:Alphaleonis.Win32.Vss.VssRestoreMethod"/> value.
+ </para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Alternate">
+ <summary>
+ <para>
+ The files are restored to a location determined from an existing alternate location mapping.
+ </para>
+ <para>
+ The restore target should be set to <see cref="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Alternate"/> only when
+ alternate location mappings have been set for all the files managed by
+ a selected component or component set.
+ </para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.Directed">
+ <summary>
+ <para>
+ Use directed targeting by the writer at restore time to restore a file.
+ </para>
+ <para>
+ Directed targeting allows a writer to control, on a file-by-file basis, how a file is
+ restored—indicating how much of a file is to be restored and into which files the backed-up file is to be restored.
+ </para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreTarget.OriginalLocation">
+ <summary>
+ <para>
+ The files are restored to the location at which they were at backup time, even if the original restore
+ method that was specified at backup time was <see cref="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreToAlternateLocation"/>.
+ </para>
+ <para>
+ <b>Windows Server 2003 and Windows XP:</b> This value is not supported.
+ </para>
+ </summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.IVssComponent">
+ <summary>
+ <para>
+ Interface containing methods for examining and modifying information about components contained in a requester's Backup Components Document.
+ </para>
+ </summary>
+ <remarks>
+ <para>
+ <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> objects can be obtained only for those components that have been explicitly added
+ to the Backup Components Document during a backup operation by the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>
+ method.
+ </para>
+ <para>
+ Information about components explicitly added during a restore operation using
+ <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddRestoreSubcomponent(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String,System.String)"/> are not available through the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/>
+ interface.
+ </para>
+ <para>
+ For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa382871(VS.85).aspx">the MSDN documentation on
+ the IVssComponent Interface</see>.
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.AdditionalRestores">
+ <summary>
+ The <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.AdditionalRestores"/> is used by a writer during incremental or differential restore
+ operations to determine whether a given component will require additional restore operations to completely retrieve it,
+ but can also be called by a requester.
+ </summary>
+ <value>
+ If <see langword="true"/>, additional restores will occur for the
+ current component. If <see langword="false"/>, additional restores will not occur.
+ </value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.BackupOptions">
+ <summary>
+ <para>
+ The backup options specified to the writer that manages the currently selected component or component set
+ by a requester using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetBackupOptions(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/>.
+ </para>
+ </summary>
+ <value>The backup options for the current writer.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.BackupStamp">
+ <summary>The backup stamp string stored by a writer for a given component.</summary>
+ <value>The backup stamp indicating the time at which the component was backed up.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.BackupSucceeded">
+ <summary>
+ The status of a complete attempt at backing up all the files of a selected component or component set as a
+ <see cref="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus"/> enumeration.
+ </summary>
+ <value>
+ <see langword="true"/> if the backup was successful and <see langword="false"/> if it was not.
+ </value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.ComponentName">
+ <summary>The logical name of this component.</summary>
+ <value>The logical name of this component.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.ComponentType">
+ <summary>The type of this component in terms of the <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.ComponentType"/> enumeration.</summary>
+ <value>The type of this component.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.FileRestoreStatus">
+ <summary>
+ The status of a completed attempt to restore all the files of a selected component or component set
+ as a <see cref="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus"/> enumeration.
+ </summary>
+ <value>
+ A value of the <see cref="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus"/> enumeration that specifies whether all files were successfully restored.
+ </value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.LogicalPath">
+ <summary>The logical path of this component.</summary>
+ <value>The logical path of this component.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.PostRestoreFailureMsg">
+ <summary>The failure message generated by a writer while handling the <c>PostRestore</c> event if one was set.</summary>
+ <value>The failure message that describes an error that occurred while processing the <c>PostRestore</c> event.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.PreRestoreFailureMsg">
+ <summary>The failure message generated by a writer while handling the <c>PreRestore</c> event if one was set.</summary>
+ <value>The failure message that describes an error that occurred while processing the <c>PreRestore</c> event.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.PreviousBackupStamp">
+ <summary>
+ A previous backup stamp loaded by a requester in the Backup Components Document. The value is used by a writer when
+ deciding if files should participate in differential or incremental backup operation.
+ </summary>
+ <value>
+ The time stamp of a previous backup so that a differential or incremental backup can be correctly implemented.
+ </value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreOptions">
+ <summary>The restore options specified to the current writer by a requester using
+ <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreOptions(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/>.</summary>
+ <value>The restore options of the writer.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreTarget">
+ <summary>The restore target (in terms of the <see cref="T:Alphaleonis.Win32.Vss.VssRestoreTarget"/> enumeration) for the current component. Can only be called during a restore operation.</summary>
+ <value>A value from the <see cref="T:Alphaleonis.Win32.Vss.VssRestoreTarget"/> enumeration containing the restore target information.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.IsSelectedForRestore">
+ <summary>Determines whether the current component has been selected to be restored.</summary>
+ <value>If the returned value of this parameter is <see langword="true"/>, the component has been selected to be restored. If <see langword="false"/>, it has not been selected.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.AlternateLocationMappings">
+ <summary>A collection of mapping information for the file set's alternate location for file restoration.</summary>
+ <value>A read-only list containing the alternate location to which files were actually restored. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
+ <remarks>See <see href="http://msdn.microsoft.com/en-us/library/aa383473(VS.85).aspx">the MSDN documentation on the IVssComponent::GetAlternateLocationMapping method</see> for more information.</remarks>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.DirectedTargets">
+ <summary>
+ Information stored by a writer, at backup time, to the Backup Components Document to indicate that when a file is to be
+ restored, it (the source file) should be remapped. The file may be restored to a new restore target and/or ranges of its data
+ restored to different locations with the restore target.
+ </summary>
+ <value>A read-only list containing the directed targets of this component. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.NewTargets">
+ <summary>
+ The new file restoration locations for the selected component or component set.
+ </summary>
+ <value>A read-only list contianing the new file restoration locations for the selected component or component set. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.PartialFiles">
+ <summary>
+ Information about any partial files associated with this component.
+ </summary>
+ <value>A read-only list containing information about any partial files associated with this component. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.DifferencedFiles">
+ <summary>
+ Information about the file sets (specified file or files) to participate in an incremental or differential backup or restore as a
+ differenced file — that is, backup and restores associated with it are to be implemented as if entire files are copied to and from
+ backup media (as opposed to using partial files).
+ </summary>
+ <remarks><b>Windows XP:</b> This method requires Windows Server 2003 or later</remarks>
+ <value>
+ A read only list containing the diffrenced files associated with this component. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note>
+ </value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreSubcomponents">
+ <summary>The subcomponents associated with this component.</summary>
+ <value>A read only list containing the subcomponents associated with this component. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.IsAuthoritativeRestore">
+ <summary>
+ Gets a value indicating whether a requester has marked the restore of a component as authoritative for a replicated data store.
+ </summary>
+ <value>
+ <see langword="true"/> if the restore is authoritative; otherwise, <see langword="false"/>.
+ </value>
+ <remarks>
+ <para>
+ A writer indicates that it supports authoritative restore by setting the
+ <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.AuthoritativeRestore"/> flag in its backup schema mask.
+ </para>
+ <para>
+ For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa384610(VS.85).aspx">Setting VSS Restore Options.</see>
+ </para>
+ <para>
+ <note>
+ <para>
+ <b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see langword="false"/>
+ on unsupported operating systems.
+ </para>
+ </note>
+ </para>
+ </remarks>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.PostSnapshotFailureMsg">
+ <summary>
+ Gets the <c>PostSnapshot</c> failure message string that a writer has set for a given component.
+ </summary>
+ <remarks>
<para>
- The writer supports backing up data that is part of the system state, but that can also
- be backed up independently of the system state.
+ Both writers and requesters can call this method.
</para>
<para>
- <b>Windows Server 2003:</b> This value is not supported until Windows Vista.
+ <note>
+ <para>
+ <b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see langword="false"/>
+ on unsupported operating systems.
+ </para>
+ </note>
</para>
- </summary>
+ </remarks>
+ <value>A string containing the failure message that describes an error that occurred while processing a PostSnapshot event, or <see langword="null"/>
+ if no value was set or the method is not supported on the current operating system.</value>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.RollForwardRestore">
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.PrepareForBackupFailureMsg">
<summary>
+ Gets the <c>PrepareForBackup</c> failure message string that a writer has set for a given component.
+ </summary>
+ <value>A string containing the failure message that describes an error that occurred while processing a PrepareForBackup event,
+ or <see langword="null"/> if no failure message was set for this component, or if the property is not supported on the
+ current operating system.</value>
+ <remarks>
<para>
- The writer supports a requester setting a roll-forward restore point using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRollForward(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,Alphaleonis.Win32.Vss.VssRollForwardType,System.String)"/>.
+ Both writers and requesters can call this method.
</para>
<para>
- <b>Windows Server 2003:</b> This value is not supported until Windows Vista.
+ <note>
+ <para>
+ <b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see langword="false"/>
+ on unsupported operating systems.
+ </para>
+ </note>
</para>
- </summary>
+ </remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.RestoreRename">
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreName">
<summary>
+ Obtains the logical name assigned to a component that is being restored.
+ </summary>
+ <value>
+ A string containing the restore name for the component, or <see langword="null"/> if the operation
+ is not supported on the current operating system.
+ </value>
+ <remarks>
<para>
- The writer supports a requester setting a restore name using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreName(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/>.
+ The <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreName"/> property can only be accessed during a restore operation.
</para>
<para>
- <b>Windows Server 2003:</b> This value is not supported until Windows Vista.
+ A writer indicates that it supports this method by setting the <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.RestoreRename"/>
+ flag in its backup schema mask.
</para>
- </summary>
+ <para>
+ For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa384610(VS.85).aspx">
+ Setting VSS Restore Options</see>.
+ </para>
+ <para>
+ <note>
+ <para>
+ <b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see langword="false"/>
+ on unsupported operating systems.
+ </para>
+ </note>
+ </para>
+ </remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.AuthoritativeRestore">
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.RollForwardRestorePoint">
<summary>
+ Obtains the restore point for a partial roll-forward operation.
+ </summary>
+ <value>
+ A string specifying the roll-forward restore point,
+ or <see langword="null"/> if the property is not supported in the current context.
+ </value>
+ <remarks>
<para>
- The writer supports a requester setting authoritative restore using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetAuthoritativeRestore(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean)"/>.
+ The <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.RollForwardRestorePoint"/> property can only be accessed during a restore operation.
</para>
<para>
- <b>Windows Server 2003:</b> This value is not supported until Windows Vista.
+ A writer indicates that it supports this method by setting the <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.RollForwardRestore"/>
+ flag in its backup schema mask.
</para>
- </summary>
+ <para>
+ For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa384610(VS.85).aspx">
+ Setting VSS Restore Options</see>.
+ </para>
+ <para>
+ <note>
+ <para>
+ <b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see cref="F:Alphaleonis.Win32.Vss.VssRollForwardType.Undefined"/>
+ on unsupported operating systems.
+ </para>
+ </note>
+ </para>
+ </remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.WriterSupportsParallelRestores">
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.RollForwardType">
<summary>
+ Obtains the roll-forward operation type for a component.
+ </summary>
+ <value>
+ A <see cref="T:Alphaleonis.Win32.Vss.VssRollForwardType"/> enumeration value indicating the type of roll-forward operation to be performed,
+ or <see cref="F:Alphaleonis.Win32.Vss.VssRollForwardType.Undefined"/> if the property is not supported in the current context.
+ </value>
+ <remarks>
<para>
- The writer supports multiple unsynchronized restore events.
+ The <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.RollForwardType"/> property can only be accessed during a restore operation.
</para>
<para>
- <b>Windows Vista and Windows Server 2003:</b> This value is not supported until Windows Server 2008.
+ A writer indicates that it supports this method by setting the <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.RollForwardRestore"/>
+ flag in its backup schema mask.
+ </para>
+ <para>
+ For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa384610(VS.85).aspx">
+ Setting VSS Restore Options</see>.
+ </para>
+ <para>
+ <note>
+ <para>
+ <b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see cref="F:Alphaleonis.Win32.Vss.VssRollForwardType.Undefined"/>
+ on unsupported operating systems.
+ </para>
+ </note>
</para>
+ </remarks>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssComponent.Failure">
+ <summary>
+ VSS requesters read this property to retrieve component-level errors reported by writers.
+ VSS writers set this property to report errors at the component level.
</summary>
+ <returns>An instance of <see cref="T:Alphaleonis.Win32.Vss.VssComponentFailure"/> containing the information reported by the writer.</returns>
+ <remarks>Minimum supported client: Windows 7, Minimum supported server: Windows Server 2008 R2</remarks>
+ <exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo">
+ <member name="T:Alphaleonis.Win32.Vss.IVssAsyncResult">
<summary>
- Contains information about a volume's shadow copy protection level.
+ Represents the status of an asynchronous operation performed by the VSS framework.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.#ctor(Alphaleonis.Win32.Vss.VssProtectionLevel,System.Boolean,Alphaleonis.Win32.Vss.VssProtectionFault,System.UInt32,System.Boolean)">
+ <member name="M:Alphaleonis.Win32.Vss.IVssAsyncResult.Cancel">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo"/> class.
+ Cancels an incomplete asynchronous operation.
</summary>
- <param name="protectionLevel">The protection level.</param>
- <param name="volumeIsOfflineForProtection">if set to <c>true</c> the volume is offline for protection.</param>
- <param name="protectionFault">The protection fault.</param>
- <param name="failureStatus">The failure status.</param>
- <param name="volumeHasUnusedDiffArea">if set to <c>true</c> the volume has unused diff area.</param>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.ProtectionLevel">
+ <member name="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException">
<summary>
- Gets the target protection level for the volume.
+ Exception indicating that the creation of a shadow copy is in progress, and only one shadow copy creation
+ operation can be in progress at one time. Either wait to try again or return with a failure.
</summary>
- <value>The target protection level for the volume.</value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.VolumeIsOfflineForProtection">
+ <member name="M:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException.#ctor">
<summary>
- Gets a value indicating whether the volume is offline due to a protection fault.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException"/>
+ class with a system-supplied message describing the error.
</summary>
- <value>
- <c>true</c> if the volume is offline due to a protection fault; otherwise, <c>false</c>.
- </value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.ProtectionFault">
+ <member name="M:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException.#ctor(System.String)">
<summary>
- Gets a value that describes the shadow copy protection fault that caused the volume to go offline.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException"/> class with a specified error message.
</summary>
- <value>A value that describes the shadow copy protection fault that caused the volume to go offline.</value>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.FailureStatus">
+ <member name="M:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException.#ctor(System.String,System.Exception)">
<summary>
- Gets the internal failure status code.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
- <value>The internal failure status code.</value>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.VolumeHasUnusedDiffArea">
+ <member name="M:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- Gets a value indicating whether the volume has unused shadow copy storage area files or not.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException"/> class.
</summary>
- <value>
- <c>true</c> if the volume has unused shadow copy storage area files; otherwise, <c>false</c>.
- </value>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException">
+ <summary>
+ Exception indicating that the writer operation failed because of an error that might recur if another shadow copy is created.
+ For more information, see <see href="http://msdn.microsoft.com/en-us/library/cc325736(VS.85).aspx">Event and Error Handling Under VSS</see>.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssNonRetryableWriterException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException"/> class.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssNonRetryableWriterException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException"/> class.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssNonRetryableWriterException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException"/> class.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssNonRetryableWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">
+ The <paramref name="info"/> parameter is <see langword="null"/>.
+ </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">
+ The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
+ </exception>
</member>
<member name="T:Alphaleonis.Win32.Vss.IVssImplementation">
<summary>
@@ -1102,32 +2253,62 @@ </summary>
<returns>A snapshot management interface for the current implementation.</returns>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssResyncInProgressException">
+ <member name="T:Alphaleonis.Win32.Vss.VssRestoreType">
+ <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssRestoreType"/> enumeration is used by a requester to indicate the type of restore operation it is about to perform.</summary>
+ <remarks>
+ <para>A requester sets the type of a restore operation using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreState(Alphaleonis.Win32.Vss.VssRestoreType)"/>.</para>
+ <!-- <para>A writer can retrieve the type of a restore operation by calling CVssWriter::GetRestoreType.</para> -->
+ </remarks>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreType.Undefined">
<summary>
- Exception thrown to indicate that another LUN resynchronization operation is already in progress.
+ <para>No restore type is defined.</para>
+ <para>This indicates an error on the part of the requester.</para>
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssResyncInProgressException.#ctor">
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreType.ByCopy">
+ <summary>The default restore type: A requester restores backed-up data to the original volume from a backup medium.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreType.Import">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssResyncInProgressException"/> class.
+ <para>
+ A requester does not copy data from a backup medium, but imports a transportable shadow copy
+ and uses this imported volume for operations such as data mining.
+ </para>
+ <para>
+ <b>Windows Server 2003, Standard Edition and Windows Server 2003, Web Edition:</b> This value is not supported. All editions of Windows Server 2003 SP1 support this value.
+ </para>
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssResyncInProgressException.#ctor(System.String)">
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreType.Other">
+ <summary>A restore type not currently enumerated. This value indicates an application error.</summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssLegacyProviderException">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssResyncInProgressException"/> class.
+ Exception indicating that this version of the hardware provider does not support this operation.
</summary>
- <param name="message">The message.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssResyncInProgressException.#ctor(System.String,System.Exception)">
+ <member name="M:Alphaleonis.Win32.Vss.VssLegacyProviderException.#ctor">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssResyncInProgressException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException"/> class.
</summary>
- <param name="message">The message.</param>
- <param name="inner">The inner.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssResyncInProgressException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="M:Alphaleonis.Win32.Vss.VssLegacyProviderException.#ctor(System.String)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssResyncInProgressException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException"/> class.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssLegacyProviderException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException"/> class.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssLegacyProviderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
@@ -1135,562 +2316,637 @@ The <paramref name="info"/> parameter is <see langword="null"/>.
</exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">
- The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
+ The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssProtectionFault">
+ <member name="T:Alphaleonis.Win32.Vss.VssVolumeProperties">
<summary>
- Defines the set of shadow copy protection faults.
- A shadow copy protection fault occurs when the VSS service is unable to perform a copy-on-
- write operation to the shadow copy storage area (also called the diff area).
+ The <see cref="T:Alphaleonis.Win32.Vss.VssVolumeProperties"/> class contains the properties of a shadow copy source volume.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.None">
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeProperties.#ctor(System.String,System.String)">
<summary>
- No shadow copy protection fault has occurred.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeProperties"/> class.
</summary>
+ <param name="volumeName">Name of the volume.</param>
+ <param name="volumeDisplayName">Display name of the volume.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.DiffAreaMissing">
+ <member name="P:Alphaleonis.Win32.Vss.VssVolumeProperties.VolumeName">
<summary>
- The volume that contains the shadow copy storage area could not be found. Usually this fault means that the volume has not yet arrived in the system.
+ Gets the volume name, in <c>\\?\Volume{GUID}\</c> format.
</summary>
+ <value>The volume name, in <c>\\?\Volume{GUID}\</c> format.</value>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.IOFailureDuringOnline">
+ <member name="P:Alphaleonis.Win32.Vss.VssVolumeProperties.VolumeDisplayName">
<summary>
- The volume that contains the shadow copy storage area could not be brought online because an I/O failure occurred.
+ Gets a string that can be displayed to the user containing the shortest mount point (for example C:\).
</summary>
+ <value>A string that can be displayed to the user containing the shortest mount point (for example C:\).</value>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.MetadataCorruption">
+ <member name="T:Alphaleonis.Win32.Vss.VssDiffVolumeProperties">
<summary>
- The shadow copy metadata for the shadow copy storage area has been corrupted.
+ The <see cref="T:Alphaleonis.Win32.Vss.VssDiffVolumeProperties"/> structure describes a shadow copy storage area volume.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.MemoryAllocationFailure">
+ <member name="M:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.#ctor(System.String,System.String,System.Int64,System.Int64)">
<summary>
- A memory allocation failure occurred. This could be caused by a temporary low-memory condition that does not happen again after you clear the fault and restart the shadow copy operation.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDiffVolumeProperties"/> class.
</summary>
+ <param name="volumeName">Name of the volume.</param>
+ <param name="volumeDisplayName">Display name of the volume.</param>
+ <param name="volumeFreeSpace">The volume free space.</param>
+ <param name="volumeTotalSpace">The volume total space.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.MappedMemoryFailure">
+ <member name="P:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.VolumeName">
<summary>
- A memory mapping failure occurred. This fault could mean that the page file is too small, or it could be caused by a low-memory condition.
+ Gets the shadow copy storage area volume name, in <c>\\?\Volume{GUID}\</c> format.
</summary>
+ <value>The shadow copy storage area volume name, in <c>\\?\Volume{GUID}\</c> format.</value>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.CowReadFailure">
+ <member name="P:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.VolumeDisplayName">
<summary>
- A read failure occurred during the copy-on-write operation when data was being copied from the live volume to the shadow copy storage area volume.
+ Gets a string that can be displayed to a user, for example <c>C:\</c>, for the shadow copy storage area volume.
</summary>
+ <value>A string that can be displayed to a user, for example <c>C:\</c>, for the shadow copy storage area volume.</value>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.CowWriteFailure">
+ <member name="P:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.VolumeFreeSpace">
<summary>
- A read or write failure occurred during the copy-on-write operation when data was being copied from the live volume to the shadow copy storage area volume. One possible reason is that the shadow copy storage area volume has been removed from the system.
+ Gets the free space, in bytes, on the shadow copy storage area volume.
</summary>
+ <value>The free space, in bytes, on the shadow copy storage area volume.</value>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.DiffAreaFull">
+ <member name="P:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.VolumeTotalSpace">
<summary>
- This failure means that either the shadow copy storage area is full or the shadow copy storage area volume is full.
- After clearing the protection fault, you can do one of the following:
- <list type="bullet">
- <item><description>Delete unused shadow copy storage areas by calling the <see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.DeleteUnusedDiffAreas(System.String)"/> method.</description></item>
- <item><description>Increase the shadow copy storage area maximum size for the volume by calling the <see cref="O:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.ChangeDiffAreaMaximumSize"/> method.</description></item>
- </list>
+ Gets the total space, in bytes, on the shadow copy storage area volume.
</summary>
+ <value>The total space, in bytes, on the shadow copy storage area volume..</value>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.GrowTooSlow">
+ <member name="T:Alphaleonis.Win32.Vss.VssBadStateException">
<summary>
- The size of the shadow copy storage area could not be increased because there was no longer enough space on the shadow copy storage area volume.
+ Exception class indicating that the vss object referenced was not in a correct state for the requested operation.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.GrowFailed">
+ <member name="M:Alphaleonis.Win32.Vss.VssBadStateException.#ctor">
<summary>
- The size of the shadow copy storage area could not be increased.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssBadStateException"/> class.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.DestroyAllSnapshots">
+ <member name="M:Alphaleonis.Win32.Vss.VssBadStateException.#ctor(System.String)">
<summary>
- An unexpected error occurred.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssBadStateException"/> class with the specified error message.
</summary>
+ <param name="message">The error message.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.FileSystemFailure">
+ <member name="M:Alphaleonis.Win32.Vss.VssBadStateException.#ctor(System.String,System.Exception)">
<summary>
- Either the shadow copy storage area files could not be opened or the shadow copy storage area volume could not be mounted because of a file system operation failure.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssBadStateException"/> class with the specified error message
+ and a reference to the inner exception that is the cause of this exception.
</summary>
+ <param name="message">The error message.</param>
+ <param name="innerException">The inner exception.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.IOFailure">
+ <member name="M:Alphaleonis.Win32.Vss.VssBadStateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- A read or write failure occurred on the shadow copy storage area volume.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssBadStateException"/> class with serialized data.
</summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.DiffAreaRemoved">
+ <member name="T:Alphaleonis.Win32.Vss.VssSourceType">
+ <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssSourceType"/> enumeration specifies the type of data that a writer manages.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSourceType.Undefined">
+ <summary><para>The source of the data is not known.</para><para>This indicates a writer error, and the requester should report it.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSourceType.TransactedDB">
+ <summary>The source of the data is a database that supports transactions, such as Microsoft SQL Server.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSourceType.NonTransactedDB">
+ <summary>The source of the data is a database that does not support transactions.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSourceType.Other">
<summary>
- The shadow copy storage area volume was removed from the system or could not be accessed for some other reason.
+ <para>Unclassified source type—data will be in a file group.</para>
+ <para>This is the default source type.</para>
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.ExternalWriterToDiffArea">
+ <member name="T:Alphaleonis.Win32.Vss.VssSnapshotContext">
<summary>
- Another application attempted to write to the shadow copy storage area.
+ The <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> enumeration enables a requester using <see cref="O:Alphaleonis.Win32.Vss.IVssBackupComponents.SetContext"/> to specify how a
+ shadow copy is to be created, queried, or deleted and the degree of writer involvement.
+ <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>::SetContext" method) may be modified by a bitmask that contains a valid combination of
+ <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> and <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> enumeration values.
</summary>
+ <remarks><see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> is defined as a static class defining the base <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/>
+ combination of values representing the VSS_CTX_XXXXXX constants defined in the VSS API.
+ </remarks>
+ <seealso cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssRevertInProgressException">
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.Backup">
<summary>
- Exception thrown to indicate that the volume already has a revert in progress.
+ The standard backup context. Specifies an auto-release, nonpersistent shadow copy in which writers are involved in the creation.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.FileShareBackup">
+ <summary>
+ Specifies a nonpersistent and auto-release shadow copy created without writer involvement.
</summary>
- <remarks>
- <note>
- <b>Windows XP and Windows 2003:</b> This error is not supported until Windows Vista.
- </note>
- </remarks>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssRevertInProgressException.#ctor">
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.NasRollback">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRevertInProgressException"/>
- class with a system-supplied message describing the error.
+ <para>Specifies a persistent and non-auto-release shadow copy without writer involvement. This context should be used when there is no need for writer involvement to ensure that files are in a consistent state at the time of the shadow copy. </para>
+ <para>Lightweight automated file rollback mechanisms or persistent shadow copies of file shares or data volumes that are not expected to contain any system-related files or databases might run under this context. For example, a requester could use this context for creating a shadow copy of a NAS volume hosting documents and simple user shares. Those types of data do not need writer involvement to create a consistent shadow copy.</para>
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssRevertInProgressException.#ctor(System.String)">
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.AppRollback">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRevertInProgressException"/> class with a specified error message.
+ <para>Specifies a persistent and non-auto-release shadow copy with writer involvement. This context is designed to be used when writers are needed to ensure that files are in a well-defined state prior to shadow copy. </para>
+ <para>Automated file rollback mechanisms of system volumes and shadow copies to be used in data mining or restore operations might run under this context. This context is similar to VSS_CTX_BACKUP but allows a requester more control over the persistence of the shadow copy.</para>
</summary>
- <param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssRevertInProgressException.#ctor(System.String,System.Exception)">
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.ClientAccessible">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRevertInProgressException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
+ <para>Specifies a read-only, client-accessible shadow copy supporting Shadow Copies for Shared Folders and created without writer involvement. Only the system provider (the default provider available on the system) can create this type of shadow copy. </para>
+ <para>Most requesters will want to use the <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.NasRollback"/> context for persistent, non-auto-release shadow copies without writer involvement.</para>
</summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssRevertInProgressException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.ClientAccessibleWriters">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRevertInProgressException"/> class.
+ <para>Specifies a read-only, client-accessible shadow copy supporting Shadow Copies for Shared Folders and created with writer involvement. Only the system provider (the default provider available on the system) can create this type of shadow copy. </para>
+ <para>Most requesters will want to use the <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.AppRollback"/> context for persistent, non-auto-release shadow copies with writer involvement.</para>
+ <para><b>Windows Server 2003 and Windows XP:</b> This context is not supported by Windows Server 2003 and Windows XP.</para>
</summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo">
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.All">
<summary>
- Represents information about a Subcomponent associated with a given component.
+ All types of currently live shadow copies are available for administrative operations, such as shadow copy queries
+ (see the Query method in <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>). <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.All"/> is a valid context for all VSS interfaces except
+ <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>::StartSnapshotSet and <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>::DoSnapshotSet.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo.#ctor(System.String,System.String)">
+ <member name="T:Alphaleonis.Win32.Vss.VssProviderType">
+ <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssProviderType"/> enumeration specifies the provider type.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssProviderType.Unknown">
<summary>
- Initializes a new instance of <see cref="T:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo"/>.
+ <para>
+ The provider type is unknown.
+ </para>
+ <para>
+ This indicates an error in the application or the VSS service, or that no provider is available.
+ </para>
</summary>
- <param name="logicalPath">The logical path of the Subcomponent. This can not be empty when working with Subcomponents.</param>
- <param name="componentName">The name of the Subcomponent. This can not be empty.</param>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo.LogicalPath">
- <summary>The logical path of the Subcomponent. This can not be empty when working with Subcomponents.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssProviderType.System">
+ <summary>The default provider that ships with Windows.</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssRestoreSubcomponentInfo.ComponentName">
- <summary>The name of the Subcomponent. This can not be empty.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssProviderType.Software">
+ <summary>A software-based provider.</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">
+ <member name="F:Alphaleonis.Win32.Vss.VssProviderType.Hardware">
+ <summary>A hardware-based provider.</summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssRecoveryOptions">
<summary>
- Exception indicating that the requested method is not supported on the current operating system, or the loaded
- assembly is targeted for a different operating system than the one on which it is running.
+ Used by a requester to specify how a resynchronization operation is to be performed.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException.#ctor">
+ <member name="F:Alphaleonis.Win32.Vss.VssRecoveryOptions.None">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> class.
+ No options.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException.#ctor(System.String)">
+ <member name="F:Alphaleonis.Win32.Vss.VssRecoveryOptions.RevertIdentityAll">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> class.
+ After the resynchronization operation is complete, the signature of each target LUN should be identical to that of the original LUN that was used to create the shadow copy.
</summary>
- <param name="message">The message.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException.#ctor(System.String,System.Exception)">
+ <member name="F:Alphaleonis.Win32.Vss.VssRecoveryOptions.NoVolumeCheck">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> class.
+ Volume safety checks should not be performed.
</summary>
- <param name="message">The message.</param>
- <param name="innerException">The inner exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="T:Alphaleonis.Win32.Vss.VssWMDependency">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> class.
+ <see cref="T:Alphaleonis.Win32.Vss.VssWMDependency"/> is used to determine the writer ID, logical path, and component name of components that must be restored or
+ backed up along with the target component.</summary>
+ <remarks>Note that a dependency does not indicate an order of preference between the component with the documented dependencies and the components it depends on. A dependency merely indicates that the component and the components it depends on must always be backed up or restored together.
+ <note><b>Windows XP:</b> This class is not supported until Windows Server 2003</note>
+ </remarks>
+ <seealso href="http://msdn.microsoft.com/en-us/library/aa384301(VS.85).aspx"/>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssWMDependency.#ctor(System.Guid,System.String,System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWMDependency"/> class.
</summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ <param name="writerId">The writer id.</param>
+ <param name="logicalPath">The logical path.</param>
+ <param name="componentName">Name of the component.</param>
</member>
- <member name="T:Alphaleonis.Win32.Vss.OperatingSystemInfo">
+ <member name="P:Alphaleonis.Win32.Vss.VssWMDependency.WriterId">
<summary>
- Static class providing access to information about the operating system under which the
- assembly is executing.
+ The class ID of a writer containing a component that the current component depends on.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsWow64Process">
+ <member name="P:Alphaleonis.Win32.Vss.VssWMDependency.LogicalPath">
<summary>
- Determines whether the current process is running under WOW64.
+ The logical path of a component that the current component depends on.
</summary>
- <returns>
- <c>true</c> if the current process is running under WOW64; otherwise, <c>false</c>.
- </returns>
</member>
- <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsAtLeast(Alphaleonis.Win32.Vss.OSVersionName)">
+ <member name="P:Alphaleonis.Win32.Vss.VssWMDependency.ComponentName">
<summary>
- Determines whether the operating system is of the specified version or later.
+ Retrieves the name of a component that the current component depends on.
</summary>
- <param name="version">The lowest version for which to return <c>true</c>.</param>
- <returns>
- <c>true</c> if the operating system is of the specified <paramref name="version"/> or later; otherwise, <c>false</c>.
- </returns>
</member>
- <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsAtLeast(Alphaleonis.Win32.Vss.OSVersionName,System.Int32)">
+ <member name="T:Alphaleonis.Win32.Vss.Resources.LocalizedStrings">
<summary>
- Determines whether operating system is of the specified version or later, allowing specification of
- a minimum service pack that must be installed on the lowest version.
+ A strongly-typed resource class, for looking up localized strings, etc.
</summary>
- <param name="version">The minimum required version.</param>
- <param name="servicePackVersion">The major version of the service pack that must be installed on the
- minimum required version to return <c>true</c>. This can be 0 to indicate that no service pack is required.</param>
- <returns>
- <c>true</c> if the operating system matches the specified <paramref name="version"/> with the specified service pack, or if the operating system is of a later version; otherwise, <c>false</c>.
- </returns>
</member>
- <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.RequireServerOrClientAtLeast(Alphaleonis.Win32.Vss.OSVersionName,System.Int32,Alphaleonis.Win32.Vss.OSVersionName,System.Int32)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ResourceManager">
<summary>
- Determines whether operating system is of the specified server version or later or if it is of the specified client
- version or later and throws <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> otherwise.
+ Returns the cached ResourceManager instance used by this class.
</summary>
- <param name="serverVersion">The minimum server version.</param>
- <param name="serverServicePackVersion">The minimum server service pack version (applies only if the version exactly matches the specified server version).</param>
- <param name="clientVersion">The minimum client version.</param>
- <param name="clientServicePackVersion">The minimum client service pack version (applies only if the version exactly matches the specified client version).</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.RequireServer(Alphaleonis.Win32.Vss.OSVersionName,System.Int32)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.Culture">
<summary>
- Determines whether the operating system is a server operating system of atleast the specified <paramref name="serverVersion"/> and
- <paramref name="serverServicePackVersion"/> and throws an <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> otherwise.
+ Overrides the current thread's CurrentUICulture property for all
+ resource lookups using this strongly typed resource class.
</summary>
- <param name="serverVersion">The server version.</param>
- <param name="serverServicePackVersion">The server service pack version.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.RequireAtLeast(Alphaleonis.Win32.Vss.OSVersionName)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.AlphaVSSRequiresAtLeastWindowsXP">
<summary>
- Determines whether the assembly is executing on the specified operating system version or later.
- If not, an exception is thrown.
+ Looks up a localized string similar to AlphaVSS requires at least Windows XP..
</summary>
- <param name="osVersion">The minimum operating system version required.</param>
- <exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The current operating system is of a version earlier than the specified <paramref name="osVersion"/></exception>
</member>
- <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.RequireAtLeast(Alphaleonis.Win32.Vss.OSVersionName,System.Int32)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.AnotherLUNResynchronizationOperationIsAlreadyInProgress">
<summary>
- Determines whether the assembly is executing on the specified operating system version with
- the specified service pack installed or any later version of windows. If not, an exception is thrown.
+ Looks up a localized string similar to Another LUN resynchronization operation is already in progress..
</summary>
- <param name="osVersion">The minimum operating system version required.</param>
- <param name="servicePackVersion">The minimum service pack version required.</param>
- <exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The current operating system is of a version earlier
- than the specified <paramref name="osVersion"/> or the versions match but the operating system does not
- have at least the specified service pack version <paramref name="servicePackVersion"/> installed.</exception>
</member>
- <member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.OSVersionName">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.AnUnexpectedErrorOccuredTheErrorCodeIsLogg">
<summary>
- Gets the named version of the operating system.
+ Looks up a localized string similar to An unexpected error occurred. The error code is logged in the error log file..
</summary>
- <value>The named version of the operating system.</value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsServer">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.AnUnexpectedErrorOccurredDuringCommunicationWithWriters">
<summary>
- Gets a value indicating whether the operating system is a server os.
+ Looks up a localized string similar to An unexpected error occurred during communication with writers..
</summary>
- <value>
- <c>true</c> if the current operating system is a server os; otherwise, <c>false</c>.
- </value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.OSVersion">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.DeletionOfSnapshotFailedSeeInnerExceptionF">
<summary>
- Gets the numeric version of the operating system. This is the same as returned by
- <see cref="P:System.Environment.OSVersion"/>.
+ Looks up a localized string similar to Deletion of snapshot failed. See inner exception for details. .
</summary>
- <value>The numeric version of the operating system.</value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.ServicePackVersion">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.DeletionOfSnapshotsFailed">
<summary>
- Gets the version of the service pack currently installed on the operating system.
+ Looks up a localized string similar to Deletion of snapshots failed.
</summary>
- <value>The version of the service pack currently installed on the operating system.</value>
- <remarks>Only the <see cref="P:System.Version.Major"/> and <see cref="P:System.Version.Minor"/> fields are
- used.</remarks>
</member>
- <member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.ProcessorArchitecture">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ExpectedProviderError">
<summary>
- Gets the processor architecture for which the operating system is targeted.
+ Looks up a localized string similar to Expected provider error. Check the event log for details..
</summary>
- <value>The processor architecture for which the operating system is targeted.</value>
- <remarks>If running under WOW64 this will return a 32-bit processor. Use <see cref="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsWow64Process"/> to
- determine if this is the case.
- </remarks>
</member>
- <member name="T:Alphaleonis.Win32.Vss.IVssAsyncResult">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.FailedToDetectArchitectureOfRunningOperati">
<summary>
- Represents the status of an asynchronous operation performed by the VSS framework.
+ Looks up a localized string similar to Failed to detect architecture of running operating system..
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.IVssAsyncResult.Cancel">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.IA64ArchitectureIsNotSupported">
<summary>
- Cancels an incomplete asynchronous operation.
+ Looks up a localized string similar to IA64 architecture is not supported..
</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.InvalidXMLDocumentCheckTheEventLogForDetails">
<summary>
- Exception indicating that the writer status is not available for one or more writers.
- A writer may have reached the maximum number of available backup and restore sessions.
+ Looks up a localized string similar to Invalid XML document. Check the event log for details..
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException.#ctor">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.MaximumDiffAreaAssociationsReached">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException"/> class.
+ Looks up a localized string similar to The maximum number of shadow copy storage areas has been added to the shadow copy source volume..
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException.#ctor(System.String)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.RequestedOperationUnsupportedByOS">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException"/> class.
+ Looks up a localized string similar to The requested operation is not supported on the current operating system..
</summary>
- <param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException.#ctor(System.String,System.Exception)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.SystemWasUnableToFreezeDtcOrKtm">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException"/> class.
+ Looks up a localized string similar to System was unable to freeze the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).
</summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheCreationOfAShadowCopyIsAlreadyInProgress">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException"/> class.
+ Looks up a localized string similar to The creation of a shadow copy is already in progress..
</summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="info"/> parameter is <see langword="null"/>.
- </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">
- The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
- </exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssVolumeInUseException">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheMaximumNumberOfVolumesHasAlreadyBeenAddedToTheShadowCopySet">
<summary>
- Exception indicating that the volume was in use and could not be locked.
+ Looks up a localized string similar to The maximum number of volumes has already been added to the shadow copy set..
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeInUseException.#ctor">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheOperationIsNotSupportedUnderTheCurrentContext">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException"/>
- class with a system-supplied message describing the error.
+ Looks up a localized string similar to The operation is not supported under the current context..
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeInUseException.#ctor(System.String)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheProviderEncounteredAnErrorThatRequiresTheUserToRestartTheComputer">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException"/> class with a specified error message.
+ Looks up a localized string similar to The provider encountered an error that requires the user to restart the computer..
</summary>
- <param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeInUseException.#ctor(System.String,System.Exception)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheProviderReturnedAnUnexpectedErrorCode">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
+ Looks up a localized string similar to The provider returned an unexpected error code..
</summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeInUseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheRequestedIdentifierDoesNotCorrespondToARegisteredProvider">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeInUseException"/> class.
+ Looks up a localized string similar to The requested identifier does not correspond to a registered provider..
</summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheRequestedObjectDoesNotExist">
<summary>
- Exception thrown to indicate that an unexpected error occurred during communication with writers.
+ Looks up a localized string similar to The requested object does not exist..
</summary>
- <remarks>
- The error code is logged in the error log file.
- </remarks>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException.#ctor">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheRequestedObjectWasADuplicate">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException"/>
- class with a system-supplied message describing the error.
+ Looks up a localized string similar to The requested object was a duplicate..
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException.#ctor(System.String)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheSystemOrProviderHasInsufficientStorageSpace">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException"/> class with a specified error message.
+ Looks up a localized string similar to The system or provider has insufficient storage space. If possible delete any old or unnecessary persistent shadow copies and try again..
</summary>
- <param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException.#ctor(System.String,System.Exception)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheSystemWasUnableToFlushIOWrites">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
+ Looks up a localized string similar to The system was unable to flush I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times..
</summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheSystemWasUnableToHoldIOWrites">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedWriterErrorException"/> class.
+ Looks up a localized string similar to The system was unable to hold I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
</summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.IVssWriterComponents">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeAlreadyHasARevertInProgress">
<summary>
- The <see cref="T:Alphaleonis.Win32.Vss.IVssWriterComponents"/> interface contains methods used to obtain and modify component information
- (in the form of <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> instances) associated with a given writer but stored in a
- requester's Backup Components Document.
+ Looks up a localized string similar to The volume already has a revert in progress..
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWriterComponents.Components">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeDoesNotSupportTheRequestedOperation">
<summary>
- A read-only collection of <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> instances to the a given writer's
- components explicitly stored in the Backup Components Document.
+ Looks up a localized string similar to The volume does not support the requested operation, or no provider supports it..
</summary>
- <value>A read-only collection of <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> instances to the a given writer's
- components explicitly stored in the Backup Components Document. <note type="caution">This list
- must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note>
- </value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWriterComponents.InstanceId">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeHasAlreadyBeenAddedToTheMaximumNumberOfShadowCopySets">
<summary>
- Identifier of the writer instance responsible for the components.
+ Looks up a localized string similar to The volume has already been added to the maximum number of shadow copy sets..
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWriterComponents.WriterId">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeIsNotSupportedByTheSpecifiedProvider">
<summary>
- Identifier of the writer class responsible for the components.
+ Looks up a localized string similar to The volume is not supported by the specified provider..
</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVolumeWasInUseAndCouldNotBeLocked">
<summary>
- A class that allows a requester to examine the metadata of a specific writer instance. This metadata may come from a
- currently executing (live) writer, or it may have been stored as an XML document.
+ Looks up a localized string similar to The volume was in use and could not be locked..
</summary>
- <remarks>
- A <see cref="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata"/> interface to a live writer's metadata is obtained by a call to
- <see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterMetadata"/>.
- </remarks>
</member>
- <member name="M:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.LoadFromXml(System.String)">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheVSSObjectWasInAnIncorrectStateForTheRequestedOperation">
<summary>
- The <see cref="M:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.LoadFromXml(System.String)"/> method loads an XML document that contains a writer's metadata document into a
- <see cref="T:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata"/> instance.
+ Looks up a localized string similar to The VSS object was in an incorrect state for the requested operation..
</summary>
- <param name="xml">String that contains an XML document that represents a writer's metadata document.</param>
- <returns><see langword="true"/> if the XML document was successfully loaded, or <see langword="false"/> if the XML document could not
- be loaded.</returns>
</member>
- <member name="M:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.SaveAsXml">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheWriterInfrastructureIsNotOperatingProperly">
<summary>
- The <see cref="M:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.SaveAsXml"/> method saves the Writer Metadata Document that contains a writer's state information to a specified string.
- This string can be saved as part of a backup operation.
+ Looks up a localized string similar to The writer infrastructure is not operating properly. Check that the Event Service and VSS have been started, and check for errors associated with those services in the error log..
</summary>
- <returns>The Writer Metadata Document that contains a writer's state information.</returns>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.BackupSchema">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.TheWriterIsNotResponding">
<summary>
- The <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.BackupSchema"/> is examined by a requester to determine from the
- Writer Metadata Document the types of backup operations that a given writer can participate in.
+ Looks up a localized string similar to The writer is not responding..
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.AlternateLocationMappings">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires01DetectedOperatingSystemWas23">
<summary>
- The alternate location mappings of the file sets.
+ Looks up a localized string similar to This operation requires {0}{1}. Detected operating system was: {2}{3}..
</summary>
- <value>A read-only list containing the alternate location mappings of the file sets.</value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.RestoreMethod">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires01OrLaterDetectedOperatingSystemWas23">
<summary>
- Information about how a writer wants its data to be restored.
+ Looks up a localized string similar to This operation requires {0}{1} or later. Detected operating system was: {2}{3}..
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Components">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires0DetectedOperatingSystemWas1">
<summary>
- Obtains the Writer Metadata Documents the components supported by this writer.
+ Looks up a localized string similar to This operation requires {0}. Detected operating system was: {1}..
</summary>
- <value>the Writer Metadata Documents the components supported by this writer.</value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.ExcludeFiles">
- <summary>Information about files that have been explicitly excluded from backup.</summary>
- <value>a read-only list containing information about files that have been explicitly excluded from backup.</value>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires0OrLaterDetectedOperatingSystemWas1">
+ <summary>
+ Looks up a localized string similar to This operation requires {0} or later. Detected operating system was: {1}..
+ </summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.InstanceId">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires0WithAtLeastServicePack1DetectedOperatingSystemWas23">
<summary>
- The instance identifier of the writer
+ Looks up a localized string similar to This operation requires {0} with at least Service Pack {1}. Detected operating system was: {2}{3}..
</summary>
- <value>The instance id.</value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.WriterId">
- <summary>The class ID of the writer</summary>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisOperationRequires0WithAtLeastServicePack1Or2WithAtLeastServicePack3DetectedOperatingSystemWas45">
+ <summary>
+ Looks up a localized string similar to This operation requires {0} with at least Service Pack {1}, or {2} with at least service pack {3}. Detected operating system was: {4}{5}..
+ </summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.WriterName">
- <summary>A string specifying the name of the writer</summary>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.ThisVersionOfTheHardwareProviderDoesNotSupportThisOperation">
+ <summary>
+ Looks up a localized string similar to This version of the hardware provider does not support this operation..
+ </summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Usage">
- <summary>A <see cref="T:Alphaleonis.Win32.Vss.VssUsageType"/> enumeration value indicating how the data managed by the writer is used on the host system.</summary>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.UnexpectedSystemError">
+ <summary>
+ Looks up a localized string similar to Unexpected system error..
+ </summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Source">
- <summary>A <see cref="T:Alphaleonis.Win32.Vss.VssSourceType"/> enumeration value indicating the type of data managed by the writer.</summary>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.UnsupportedOperatingSystemExceptionMessage">
+ <summary>
+ Looks up a localized string similar to The requested method is not supported on the current operating system, or the loaded assembly is targeted for a different operating system than the one on which it is running..
+ </summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.InstanceName">
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssCannotRevertDiskIdExceptionMessage">
<summary>
- Gets the writer instance name.
+ Looks up a localized string similar to The MBR signature or GPT ID for one or more disks could not be set to the intended value. Check the Application event log for more information..
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssInconsistentSnapshotWriterExceptionMessage">
+ <summary>
+ Looks up a localized string similar to The shadow copy contains only a subset of the volumes needed by the writer to correctly back up the application component..
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssNonRetryableWriterExceptionMessage">
+ <summary>
+ Looks up a localized string similar to The writer operation failed because of an error that might recur if another shadow copy is created..
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssOutOfResourcesExceptionMessage">
+ <summary>
+ Looks up a localized string similar to The writer ran out of memory or other system resources..
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssPartialFailureWriterExceptionMessage">
+ <summary>
+ Looks up a localized string similar to The writer is reporting one or more component-level errors..
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssRetryableWriterExceptionMessage">
+ <summary>
+ Looks up a localized string similar to The writer failed due to an error that would likely not occur if the entire backup, restore, or shadow copy creation process was restarted.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssSnapshotNotInSetExceptionMessage">
+ <summary>
+ Looks up a localized string similar to The specified snapshot specifies a shadow copy that does not exist in the Backup Components Document..
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssTimeoutWriterExceptionMessage">
+ <summary>
+ Looks up a localized string similar to The writer operation failed because of a time-out between the Freeze and Thaw events..
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssUnselectedVolumeExceptionMessage">
+ <summary>
+ Looks up a localized string similar to The resynchronization destination contained a volume that was not explicitly included..
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.Resources.LocalizedStrings.VssWriterStatusNotAvailableExceptionMessage">
+ <summary>
+ Looks up a localized string similar to Writer status is not available for one or more writers. A writer may have reached the maximum number of available backup and restore sessions..
+ </summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.IVssWMComponent">
+ <summary>
+ <see cref="T:Alphaleonis.Win32.Vss.IVssWMComponent"/> is a class that allows access to component information stored in a Writer Metadata Document.
+ Instances of <see cref="T:Alphaleonis.Win32.Vss.IVssWMComponent"/> are obtained by enumerating <cee cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Components"/>.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.IVssWMComponent.GetIcon">
+ <summary>
+ Gets a buffer containing the binary data for a displayable icon representing the component.
</summary>
<remarks>
- <note>
- <para>
- <b>Windows XP and Windows 2003:</b> This property is not supported until Windows 2003 SP1 and will always return
- <see langword="null"/> on those systems.
- </para>
- </note>
+ The buffer contents should use the same format as the standard icon (.ico) files. If the writer that created
+ the component did not choose to specify an icon, the value will be <see langword="null"/>.
</remarks>
- <value>A string specifying the writer instance name.</value>
+ <returns>A buffer containing the binary data for a displayable icon representing the component. </returns>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Version">
+ <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Type">
<summary>
- Gets the version information for a writer application.
+ The component type.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.LogicalPath">
+ <summary>
+ The logical path of the component.
+ </summary>
+ <value>A string containing the logical path of the component, which may be <see langword="null"/>.
+ <remarks>There are no restrictions on the characters that can appear in a non-NULL logical path.</remarks></value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.ComponentName">
+ <summary>
+ The name of the component. A component name string cannot be <see langword="null"/>.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Caption">
+ <summary>
+ The description of the component. A caption string can be <see langword="null" />.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.RestoreMetadata">
+ <summary>
+ Boolean that indicates whether there is private metadata associated with the restoration of the component.
+ </summary>
+ <value>
+ The Boolean is <see langword="true"/> if there is private metadata associated with the restoration
+ of the components, and <see langword="false"/> if there is not.
+ </value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.NotifyOnBackupComplete">
+ <summary>Reserved for future use.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Selectable">
+ <summary>
+ Boolean that indicates (for component mode operations) if the component is selectable for backup.
</summary>
- <value>The version information for a writer application.</value>
<remarks>
- <para>
- Only the <see cref="P:System.Version.Major"/> and <see cref="P:System.Version.Minor"/> properties of the <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Version"/> instance
- are used by VSS.
- </para>
- <para>
- <note><b>Windows XP and Windows 2003:</b> This property is not supported until Windows Vista, and will always return version 0.0.0.0</note>
- </para>
+ The value of <see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.Selectable"/> helps determine whether a requester has the option of including or excluding
+ a given component in backup operations.
</remarks>
+ <value>
+ <see langword="true"/> if the component is selectable for backup and <see langword="false"/> if it is not.
+ </value>
+ <seealso href="http://msdn.microsoft.com/en-us/library/aa384680(VS.85).aspx">VSS_COMPONENTINFO structure on MSDN</seealso>
</member>
- <member name="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.ExcludeFromSnapshotFiles">
+ <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.SelectableForRestore">
<summary>
- Obtains information about file sets that have been explicitly excluded from a given shadow copy.
+ Boolean that indicates (for component-mode operations) whether the component is selectable for restore.
</summary>
<remarks>
<para>
- The <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.ExcludeFromSnapshotFiles"/> property is intended to report information about file sets excluded from a
- shadow copy. Requesters should not exclude files from backup based on the information returned by this method.
+ <see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.SelectableForRestore"/> allows the requester to determine whether this component can be individually selected
+ for restore if it had earlier been implicitly included in the backup.
</para>
<para>
<note>
- <para><b>Windows XP and Windows 2003:</b> This property is not supported until Windows Vista and will always return an empty list.</para>
+ <b>Windows XP:</b> This requires Windows Server 2003 or later. It will always return false on earlier operating systems.
</note>
</para>
+ </remarks>
+ <value>
+ The Boolean is <see langword="true"/> if the component is selectable for restore and <see langword="false"/> if it is not.
+ </value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.ComponentFlags">
+ <summary>
+ A bit mask (or bitwise OR) of values of the <see cref="T:Alphaleonis.Win32.Vss.VssComponentFlags"/> enumeration, indicating the
+ features this component supports.
+ </summary>
+ <remarks>
+ <note>
+ <b>Windows Server 2003 and Windows XP:</b> Before Windows Server 2003 SP1, this member is reserved for system use and
+ will always return <see cref="F:Alphaleonis.Win32.Vss.VssComponentFlags.None"/>.
+ </note>
</remarks>
- <value>The exclude from snapshot files.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Files">
+ <summary>
+ The file descriptors associated with this component.
+ </summary>
+ <remarks>This collection represents the method <c>GetFile()</c> of <c>IVssWMComponent</c> in the VSS API</remarks>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.DatabaseFiles">
+ <summary>
+ A list of <see cref="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor"/> instances containing information about the database backup component files.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.DatabaseLogFiles">
+ <summary>
+ A list of file descriptors for the log files associated with the specified database backup component.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Dependencies">
+ <summary>
+ A list of <see cref="T:Alphaleonis.Win32.Vss.VssWMDependency"/> instances containing accessors for obtaining information about explicit writer-component
+ dependencies of one of the current components.
+ </summary>
+ <remarks>This will always be an empty list on operating systems earlier than Windows Server 2003.</remarks>
</member>
<member name="T:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement">
<summary>
@@ -2313,2345 +3569,6 @@ </para>
</remarks>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException">
- <summary>
- Exception indicating that the writer is not responding.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterNotRespondingException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException"/> class.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterNotRespondingException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException"/> class.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterNotRespondingException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException"/> class.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterNotRespondingException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterNotRespondingException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="info"/> parameter is <see langword="null"/>.
- </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">
- The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
- </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException">
- <summary>
- Exception thrown to indicate that the system was unable to hold I/O writes.
- </summary>
- <remarks>
- This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
- </remarks>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException"/>
- class with a system-supplied message describing the error.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException">
- <summary>
- Exception indicating that the maximum number of shadow copy storage areas has been added to
- the shadow copy source volume. The specified shadow copy storage volume was not associated
- with the specified shadow copy source volume.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException"/>
- class with a system-supplied message describing the error.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException">
- <summary>
- Exception indicating the writer is reporting one or more component-level errors.
- To retrieve the errors, the requester must use the <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.Failure"/> property.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssPartialFailureWriterException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException"/> class.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssPartialFailureWriterException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException"/> class.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssPartialFailureWriterException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException"/> class.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssPartialFailureWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="info"/> parameter is <see langword="null"/>.
- </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">
- The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
- </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssDiffAreaProperties">
- <summary>
- The <see cref="T:Alphaleonis.Win32.Vss.VssDiffAreaProperties"/> structure describes associations between volumes containing the original file data
- and volumes containing the shadow copy storage area (also known as the diff area).
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssDiffAreaProperties.#ctor(System.String,System.String,System.Int64,System.Int64,System.Int64)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDiffAreaProperties"/> class.
- </summary>
- <param name="volumeName">Name of the volume.</param>
- <param name="diffAreaVolumeName">Name of the diff area volume.</param>
- <param name="maximumDiffSpace">The maximum diff space.</param>
- <param name="allocatedDiffSpace">The allocated diff space.</param>
- <param name="usedDiffSpace">The used diff space.</param>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.VolumeName">
- <summary>
- Gets the original volume name.
- </summary>
- <value>The original volume name.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.DiffAreaVolumeName">
- <summary>
- Gets the shadow copy storage area volume name.
- </summary>
- <value>The shadow copy storage area volume name.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.MaximumDiffSpace">
- <summary>
- Gets the maximum space used on the shadow copy storage area volume for this association.
- </summary>
- <value>The maximum space used on the shadow copy storage area volume for this association.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.AllocatedDiffSpace">
- <summary>
- Gets the allocated space on the shadow copy storage area volume by this association.
- This must be less than or equal to <see cref="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.MaximumDiffSpace"/>.
- </summary>
- <value>The allocated space on the shadow copy storage area volume by this association.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.UsedDiffSpace">
- <summary>
- Gets the used space from the allocated area. This must be less than or equal to <see cref="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.AllocatedDiffSpace"/>.
- </summary>
- <value>The the used space from the allocated area.</value>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.IVssComponent">
- <summary>
- <para>
- Interface containing methods for examining and modifying information about components contained in a requester's Backup Components Document.
- </para>
- </summary>
- <remarks>
- <para>
- <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> objects can be obtained only for those components that have been explicitly added
- to the Backup Components Document during a backup operation by the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddComponent(System.Guid,System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String)"/>
- method.
- </para>
- <para>
- Information about components explicitly added during a restore operation using
- <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddRestoreSubcomponent(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String,System.String)"/> are not available through the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/>
- interface.
- </para>
- <para>
- For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa382871(VS.85).aspx">the MSDN documentation on
- the IVssComponent Interface</see>.
- </para>
- </remarks>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.AdditionalRestores">
- <summary>
- The <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.AdditionalRestores"/> is used by a writer during incremental or differential restore
- operations to determine whether a given component will require additional restore operations to completely retrieve it,
- but can also be called by a requester.
- </summary>
- <value>
- If <see langword="true"/>, additional restores will occur for the
- current component. If <see langword="false"/>, additional restores will not occur.
- </value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.BackupOptions">
- <summary>
- <para>
- The backup options specified to the writer that manages the currently selected component or component set
- by a requester using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetBackupOptions(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/>.
- </para>
- </summary>
- <value>The backup options for the current writer.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.BackupStamp">
- <summary>The backup stamp string stored by a writer for a given component.</summary>
- <value>The backup stamp indicating the time at which the component was backed up.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.BackupSucceeded">
- <summary>
- The status of a complete attempt at backing up all the files of a selected component or component set as a
- <see cref="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus"/> enumeration.
- </summary>
- <value>
- <see langword="true"/> if the backup was successful and <see langword="false"/> if it was not.
- </value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.ComponentName">
- <summary>The logical name of this component.</summary>
- <value>The logical name of this component.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.ComponentType">
- <summary>The type of this component in terms of the <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.ComponentType"/> enumeration.</summary>
- <value>The type of this component.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.FileRestoreStatus">
- <summary>
- The status of a completed attempt to restore all the files of a selected component or component set
- as a <see cref="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus"/> enumeration.
- </summary>
- <value>
- A value of the <see cref="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus"/> enumeration that specifies whether all files were successfully restored.
- </value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.LogicalPath">
- <summary>The logical path of this component.</summary>
- <value>The logical path of this component.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.PostRestoreFailureMsg">
- <summary>The failure message generated by a writer while handling the <c>PostRestore</c> event if one was set.</summary>
- <value>The failure message that describes an error that occurred while processing the <c>PostRestore</c> event.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.PreRestoreFailureMsg">
- <summary>The failure message generated by a writer while handling the <c>PreRestore</c> event if one was set.</summary>
- <value>The failure message that describes an error that occurred while processing the <c>PreRestore</c> event.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.PreviousBackupStamp">
- <summary>
- A previous backup stamp loaded by a requester in the Backup Components Document. The value is used by a writer when
- deciding if files should participate in differential or incremental backup operation.
- </summary>
- <value>
- The time stamp of a previous backup so that a differential or incremental backup can be correctly implemented.
- </value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreOptions">
- <summary>The restore options specified to the current writer by a requester using
- <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreOptions(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/>.</summary>
- <value>The restore options of the writer.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreTarget">
- <summary>The restore target (in terms of the <see cref="T:Alphaleonis.Win32.Vss.VssRestoreTarget"/> enumeration) for the current component. Can only be called during a restore operation.</summary>
- <value>A value from the <see cref="T:Alphaleonis.Win32.Vss.VssRestoreTarget"/> enumeration containing the restore target information.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.IsSelectedForRestore">
- <summary>Determines whether the current component has been selected to be restored.</summary>
- <value>If the returned value of this parameter is <see langword="true"/>, the component has been selected to be restored. If <see langword="false"/>, it has not been selected.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.AlternateLocationMappings">
- <summary>A collection of mapping information for the file set's alternate location for file restoration.</summary>
- <value>A read-only list containing the alternate location to which files were actually restored. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
- <remarks>See <see href="http://msdn.microsoft.com/en-us/library/aa383473(VS.85).aspx">the MSDN documentation on the IVssComponent::GetAlternateLocationMapping method</see> for more information.</remarks>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.DirectedTargets">
- <summary>
- Information stored by a writer, at backup time, to the Backup Components Document to indicate that when a file is to be
- restored, it (the source file) should be remapped. The file may be restored to a new restore target and/or ranges of its data
- restored to different locations with the restore target.
- </summary>
- <value>A read-only list containing the directed targets of this component. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.NewTargets">
- <summary>
- The new file restoration locations for the selected component or component set.
- </summary>
- <value>A read-only list contianing the new file restoration locations for the selected component or component set. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.PartialFiles">
- <summary>
- Information about any partial files associated with this component.
- </summary>
- <value>A read-only list containing information about any partial files associated with this component. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.DifferencedFiles">
- <summary>
- Information about the file sets (specified file or files) to participate in an incremental or differential backup or restore as a
- differenced file — that is, backup and restores associated with it are to be implemented as if entire files are copied to and from
- backup media (as opposed to using partial files).
- </summary>
- <remarks><b>Windows XP:</b> This method requires Windows Server 2003 or later</remarks>
- <value>
- A read only list containing the diffrenced files associated with this component. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note>
- </value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreSubcomponents">
- <summary>The subcomponents associated with this component.</summary>
- <value>A read only list containing the subcomponents associated with this component. <note type="caution">This list must not be accessed after the <see cref="T:Alphaleonis.Win32.Vss.IVssComponent"/> from which it was obtained has been disposed.</note></value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.IsAuthoritativeRestore">
- <summary>
- Gets a value indicating whether a requester has marked the restore of a component as authoritative for a replicated data store.
- </summary>
- <value>
- <see langword="true"/> if the restore is authoritative; otherwise, <see langword="false"/>.
- </value>
- <remarks>
- <para>
- A writer indicates that it supports authoritative restore by setting the
- <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.AuthoritativeRestore"/> flag in its backup schema mask.
- </para>
- <para>
- For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa384610(VS.85).aspx">Setting VSS Restore Options.</see>
- </para>
- <para>
- <note>
- <para>
- <b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see langword="false"/>
- on unsupported operating systems.
- </para>
- </note>
- </para>
- </remarks>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.PostSnapshotFailureMsg">
- <summary>
- Gets the <c>PostSnapshot</c> failure message string that a writer has set for a given component.
- </summary>
- <remarks>
- <para>
- Both writers and requesters can call this method.
- </para>
- <para>
- <note>
- <para>
- <b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see langword="false"/>
- on unsupported operating systems.
- </para>
- </note>
- </para>
- </remarks>
- <value>A string containing the failure message that describes an error that occurred while processing a PostSnapshot event, or <see langword="null"/>
- if no value was set or the method is not supported on the current operating system.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.PrepareForBackupFailureMsg">
- <summary>
- Gets the <c>PrepareForBackup</c> failure message string that a writer has set for a given component.
- </summary>
- <value>A string containing the failure message that describes an error that occurred while processing a PrepareForBackup event,
- or <see langword="null"/> if no failure message was set for this component, or if the property is not supported on the
- current operating system.</value>
- <remarks>
- <para>
- Both writers and requesters can call this method.
- </para>
- <para>
- <note>
- <para>
- <b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see langword="false"/>
- on unsupported operating systems.
- </para>
- </note>
- </para>
- </remarks>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreName">
- <summary>
- Obtains the logical name assigned to a component that is being restored.
- </summary>
- <value>
- A string containing the restore name for the component, or <see langword="null"/> if the operation
- is not supported on the current operating system.
- </value>
- <remarks>
- <para>
- The <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.RestoreName"/> property can only be accessed during a restore operation.
- </para>
- <para>
- A writer indicates that it supports this method by setting the <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.RestoreRename"/>
- flag in its backup schema mask.
- </para>
- <para>
- For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa384610(VS.85).aspx">
- Setting VSS Restore Options</see>.
- </para>
- <para>
- <note>
- <para>
- <b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see langword="false"/>
- on unsupported operating systems.
- </para>
- </note>
- </para>
- </remarks>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.RollForwardRestorePoint">
- <summary>
- Obtains the restore point for a partial roll-forward operation.
- </summary>
- <value>
- A string specifying the roll-forward restore point,
- or <see langword="null"/> if the property is not supported in the current context.
- </value>
- <remarks>
- <para>
- The <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.RollForwardRestorePoint"/> property can only be accessed during a restore operation.
- </para>
- <para>
- A writer indicates that it supports this method by setting the <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.RollForwardRestore"/>
- flag in its backup schema mask.
- </para>
- <para>
- For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa384610(VS.85).aspx">
- Setting VSS Restore Options</see>.
- </para>
- <para>
- <note>
- <para>
- <b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see cref="F:Alphaleonis.Win32.Vss.VssRollForwardType.Undefined"/>
- on unsupported operating systems.
- </para>
- </note>
- </para>
- </remarks>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.RollForwardType">
- <summary>
- Obtains the roll-forward operation type for a component.
- </summary>
- <value>
- A <see cref="T:Alphaleonis.Win32.Vss.VssRollForwardType"/> enumeration value indicating the type of roll-forward operation to be performed,
- or <see cref="F:Alphaleonis.Win32.Vss.VssRollForwardType.Undefined"/> if the property is not supported in the current context.
- </value>
- <remarks>
- <para>
- The <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.RollForwardType"/> property can only be accessed during a restore operation.
- </para>
- <para>
- A writer indicates that it supports this method by setting the <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.RollForwardRestore"/>
- flag in its backup schema mask.
- </para>
- <para>
- For more information, see <see href="http://msdn.microsoft.com/en-us/library/aa384610(VS.85).aspx">
- Setting VSS Restore Options</see>.
- </para>
- <para>
- <note>
- <para>
- <b>Windows XP and Windows 2003:</b> This property requires Windows Vista or later and will always return <see cref="F:Alphaleonis.Win32.Vss.VssRollForwardType.Undefined"/>
- on unsupported operating systems.
- </para>
- </note>
- </para>
- </remarks>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssComponent.Failure">
- <summary>
- VSS requesters read this property to retrieve component-level errors reported by writers.
- VSS writers set this property to report errors at the component level.
- </summary>
- <returns>An instance of <see cref="T:Alphaleonis.Win32.Vss.VssComponentFailure"/> containing the information reported by the writer.</returns>
- <remarks>Minimum supported client: Windows 7, Minimum supported server: Windows Server 2008 R2</remarks>
- <exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException">
- <summary>
- Exception thrown to indicate that the volume has been added to the maximum number of shadow copy sets.
- The specified volume was not added to the shadow copy set.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException"/>
- class with a system-supplied message describing the error.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfVolumesReachedException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssSourceType">
- <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssSourceType"/> enumeration specifies the type of data that a writer manages.</summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSourceType.Undefined">
- <summary><para>The source of the data is not known.</para><para>This indicates a writer error, and the requester should report it.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSourceType.TransactedDB">
- <summary>The source of the data is a database that supports transactions, such as Microsoft SQL Server.</summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSourceType.NonTransactedDB">
- <summary>The source of the data is a database that does not support transactions.</summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSourceType.Other">
- <summary>
- <para>Unclassified source type—data will be in a file group.</para>
- <para>This is the default source type.</para>
- </summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssSnapshotProperties">
- <summary>
- The <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotProperties"/> class contains the properties of a shadow copy or shadow copy set.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssSnapshotProperties.#ctor(System.Guid,System.Guid,System.Int64,System.String,System.String,System.String,System.String,System.String,System.String,System.Guid,Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes,System.DateTime,Alphaleonis.Win32.Vss.VssSnapshotState)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotProperties"/> class.
- </summary>
- <param name="snapshotId">The snapshot id.</param>
- <param name="snapshotSetId">The snapshot set id.</param>
- <param name="snapshotCount">The snapshot count.</param>
- <param name="snapshotDeviceObject">The snapshot device object.</param>
- <param name="originalVolumeName">Name of the original volume.</param>
- <param name="originatingMachine">The originating machine.</param>
- <param name="serviceMachine">The service machine.</param>
- <param name="exposedName">Name of the exposed.</param>
- <param name="exposedPath">The exposed path.</param>
- <param name="providerId">The provider id.</param>
- <param name="snapshotAttributes">The snapshot attributes.</param>
- <param name="creationTimestamp">The creation timestamp.</param>
- <param name="snapshotState">State of the snapshot.</param>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotId">
- <summary>A <see cref="T:System.Guid"/> uniquely identifying the shadow copy identifier.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotSetId">
- <summary>A <see cref="T:System.Guid"/> uniquely identifying the shadow copy set containing the shadow copy.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotsCount">
- <summary>
- <para>
- Number of volumes included with the shadow copy in the shadow copy set when it was created.
- Because it is possible for applications to release individual shadow copies without releasing the shadow copy
- set, at any given time the number of shadow copies in the shadow copy set may be less than <see cref="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotsCount"/>
- </para>
- <para>
- The maximum number of shadow-copied volumes permitted in a shadow copy set is 64.
- </para>
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotDeviceObject">
- <summary>
- <para>
- The name of the device object for the shadow copy of the volume. The device object can be thought of as
- the root of a shadow copy of a volume. Requesters will use this device name when accessing files on a
- shadow-copied volume that it needs to work with.
- </para>
- <para>
- The device name does not contain a trailing "\".
- </para>
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.OriginalVolumeName">
- <summary>The name of the volume that had been shadow copied.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.OriginatingMachine">
- <summary>The name of the machine containing the original volume.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.ServiceMachine">
- <summary>The name of the machine running the Volume Shadow Copy Service that created the shadow copy.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.ExposedName">
- <summary>The name of the shadow copy when it is exposed. This is a drive letter or mount point (if the shadow copy is exposed as a local volume), or a share name. </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.ExposedPath">
- <summary>The portion of the shadow copy of a volume made available if it is exposed as a share.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.ProviderId">
- <summary>A <see cref="T:System.Guid"/> uniquely identifying the provider used to create this shadow copy.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotAttributes">
- <summary>
- The attributes of the shadow copy expressed as a bit mask (or bitwise OR) of members of
- the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> enumeration.
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.CreationTimestamp">
- <summary>Time stamp indicating when the shadow copy was created. The exact time is determined by the provider.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.Status">
- <summary>Current shadow copy creation status. See <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotState"/>.</summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.IVssWMComponent">
- <summary>
- <see cref="T:Alphaleonis.Win32.Vss.IVssWMComponent"/> is a class that allows access to component information stored in a Writer Metadata Document.
- Instances of <see cref="T:Alphaleonis.Win32.Vss.IVssWMComponent"/> are obtained by enumerating <cee cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Components"/>.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.IVssWMComponent.GetIcon">
- <summary>
- Gets a buffer containing the binary data for a displayable icon representing the component.
- </summary>
- <remarks>
- The buffer contents should use the same format as the standard icon (.ico) files. If the writer that created
- the component did not choose to specify an icon, the value will be <see langword="null"/>.
- </remarks>
- <returns>A buffer containing the binary data for a displayable icon representing the component. </returns>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Type">
- <summary>
- The component type.
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.LogicalPath">
- <summary>
- The logical path of the component.
- </summary>
- <value>A string containing the logical path of the component, which may be <see langword="null"/>.
- <remarks>There are no restrictions on the characters that can appear in a non-NULL logical path.</remarks></value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.ComponentName">
- <summary>
- The name of the component. A component name string cannot be <see langword="null"/>.
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Caption">
- <summary>
- The description of the component. A caption string can be <see langword="null" />.
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.RestoreMetadata">
- <summary>
- Boolean that indicates whether there is private metadata associated with the restoration of the component.
- </summary>
- <value>
- The Boolean is <see langword="true"/> if there is private metadata associated with the restoration
- of the components, and <see langword="false"/> if there is not.
- </value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.NotifyOnBackupComplete">
- <summary>Reserved for future use.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Selectable">
- <summary>
- Boolean that indicates (for component mode operations) if the component is selectable for backup.
- </summary>
- <remarks>
- The value of <see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.Selectable"/> helps determine whether a requester has the option of including or excluding
- a given component in backup operations.
- </remarks>
- <value>
- <see langword="true"/> if the component is selectable for backup and <see langword="false"/> if it is not.
- </value>
- <seealso href="http://msdn.microsoft.com/en-us/library/aa384680(VS.85).aspx">VSS_COMPONENTINFO structure on MSDN</seealso>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.SelectableForRestore">
- <summary>
- Boolean that indicates (for component-mode operations) whether the component is selectable for restore.
- </summary>
- <remarks>
- <para>
- <see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.SelectableForRestore"/> allows the requester to determine whether this component can be individually selected
- for restore if it had earlier been implicitly included in the backup.
- </para>
- <para>
- <note>
- <b>Windows XP:</b> This requires Windows Server 2003 or later. It will always return false on earlier operating systems.
- </note>
- </para>
- </remarks>
- <value>
- The Boolean is <see langword="true"/> if the component is selectable for restore and <see langword="false"/> if it is not.
- </value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.ComponentFlags">
- <summary>
- A bit mask (or bitwise OR) of values of the <see cref="T:Alphaleonis.Win32.Vss.VssComponentFlags"/> enumeration, indicating the
- features this component supports.
- </summary>
- <remarks>
- <note>
- <b>Windows Server 2003 and Windows XP:</b> Before Windows Server 2003 SP1, this member is reserved for system use and
- will always return <see cref="F:Alphaleonis.Win32.Vss.VssComponentFlags.None"/>.
- </note>
- </remarks>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Files">
- <summary>
- The file descriptors associated with this component.
- </summary>
- <remarks>This collection represents the method <c>GetFile()</c> of <c>IVssWMComponent</c> in the VSS API</remarks>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.DatabaseFiles">
- <summary>
- A list of <see cref="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor"/> instances containing information about the database backup component files.
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.DatabaseLogFiles">
- <summary>
- A list of file descriptors for the log files associated with the specified database backup component.
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.IVssWMComponent.Dependencies">
- <summary>
- A list of <see cref="T:Alphaleonis.Win32.Vss.VssWMDependency"/> instances containing accessors for obtaining information about explicit writer-component
- dependencies of one of the current components.
- </summary>
- <remarks>This will always be an empty list on operating systems earlier than Windows Server 2003.</remarks>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException">
- <summary>
- Exception thrown to indicate that the system was unable to thaw the
- Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).
- </summary>
- <remarks>
- <note>
- <b>Windows Server 2003 and Windows XP:</b> This exception is not supported until Windows Vista.
- </note>
- </remarks>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException"/>
- class with a system-supplied message describing the error.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssProviderVetoException">
- <summary>
- Exception thrown to indicate an expected provider error. The provider logged the error in the event log.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssProviderVetoException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException"/>
- class with a system-supplied message describing the error.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssProviderVetoException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssProviderVetoException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssProviderVetoException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException">
- <summary>
- Exception thrown to indicate The system was unable to flush I/O writes.
- </summary>
- <remarks>
- This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
- </remarks>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException"/>
- class with a system-supplied message describing the error.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssFlushWritesTimeoutException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssRestoreMethod">
- <summary>This enumeration is used by a writer at backup time to specify through its Writer Metadata Document the default file restore
- method to be used with all the files in all the components it manages.</summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.Undefined">
- <summary>
- <para>No restore method is defined.</para>
- <para>This indicates an error on the part of the writer.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreIfNotThere">
- <summary>
- A requester will restore files of a selected component or component set only if there are no versions of those files currently on the disk.
- </summary>
- <remarks>
- <para>Unless alternate location mappings are defined for file restoration, if a version of any file managed by a selected component or component set is currently on the disk, none of the files managed by the selected component or component set will be restored.</para>
- <para>If a file's alternate location mapping is defined, and a version of the files is present on disk at the original location, files will be written to the alternate location as long as no version of the file exists at the alternate location.</para>
- </remarks>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreIfCanReplace">
- <summary>
- A requester will restore files of a selected component or component set only if there are no versions of those files currently on the disk that cannot be overwritten.
- </summary>
- <remarks>
- <para>Unless alternate location mappings are defined for file restoration, if there is a version of any file that cannot be overwritten of the selected component or component set on the disk, none of the files managed by the component or component set will be restored.</para>
- <para>If a file's alternate location mapping is defined, files will be written to the alternate location.</para>
- </remarks>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.StopRestoreStart">
- <summary>
- This value is used by a writer to indicates that a given service must be stopped prior to the start of the restore. After the restore operation, the service will be restarted.
- </summary>
- <remarks>
- The service to be stopped is specified by an argument to <c>IVssCreateWriterMetadata.SetRestoreMethod</c>.
- </remarks>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreToAlternateLocation">
- <summary>
- A requester must restore the files of a selected component or component set to the location specified by the alternate location mapping specified in the writer component metadata file.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreAtReboot">
- <summary>
- A requester will restore the files of a selected component or component set following a reboot of the system.
- <para>
- Files to be restored should be copied to a temporary location, and the requester should use <c>File.Move</c> with the <c>DelayUntilReboot</c> flag
- to complete the restoration of these files to their proper location following reboot. (Using AlphaFS for file operations).
- </para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreAtRebootIfCannotReplace">
- <summary>
- If possible, a requester will restore the files of a selected component or component set to their correct location immediately.
- </summary>
- <remarks>
- <para>If there are versions of any of the files managed by the selected component or component set on the disk that cannot be overwritten, then all the files managed by the selected component or component set will be restored following the reboot of the system.</para>
- <para>In this case, files to be restored should be copied to a temporary location, and the requester should use <c>File.Move</c> with the <c>DelayUntilReboot</c> flag
- to complete the restoration of these files to their proper location following reboot. (Using AlphaFS for file operations). </para>
- <note><b>Windows XP:</b> This value is not supported until Windows Server 2003</note>
- </remarks>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.Custom">
- <summary>
- This value indicates that a custom restore method will be used to restore the files managed by the selected component or component set.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreStopStart">
- <summary>
- The requester should perform the restore operation as follows:
- <list type="number">
- <item><description>Send the PreRestore event and wait for all writers to process it.</description></item>
- <item><description>Restore the files to their original locations.</description></item>
- <item><description>Send the PostRestore event and wait for all writers to process it.</description></item>
- <item><description>Stop the service.</description></item>
- <item><description>Restart the service.</description></item>
- </list>
- <para>The service to be stopped is specified by the writer beforehand when it calls the IVssCreateWriterMetadata::SetRestoreMethod method.
- The requester can obtain the name of the service by examining the <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.RestoreMethod"/> property.</para>
- </summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssWriterStatusInfo">
- <summary>
- Represenation of the status for a specific writer.
- </summary>
- <remarks>This class acts as a container for the information returned from
- <see href="http://msdn.microsoft.com/en-us/library/aa382680(VS.85).aspx">IVssBackupComponents.GetWriterStatus</see> in the original
- VSS API</remarks>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterStatusInfo.#ctor(System.Guid,System.Guid,System.String,Alphaleonis.Win32.Vss.VssWriterState,Alphaleonis.Win32.Vss.VssError,System.Nullable{System.Int32},System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusInfo"/> class.
- </summary>
- <param name="instanceId">The writer instance id.</param>
- <param name="writerClassId">The writer class id.</param>
- <param name="writerName">Name of the writer.</param>
- <param name="state">The state.</param>
- <param name="failure">The failure.</param>
- <param name="applicationErrorCode">The application error code.</param>
- <param name="applicationErrorMessage">The application error message.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterStatusInfo.#ctor(System.Guid,System.Guid,System.String,Alphaleonis.Win32.Vss.VssWriterState,Alphaleonis.Win32.Vss.VssError)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusInfo"/> class.
- </summary>
- <param name="instanceId">The writer instance id.</param>
- <param name="writerId">The writer class id.</param>
- <param name="writerName">Name of the writer.</param>
- <param name="state">The state.</param>
- <param name="failure">The failure.</param>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.InstanceId">
- <summary>
- The instance id of the writer.
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.ClassId">
- <summary>
- The identifier of the writer class.
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.Name">
- <summary>
- The name of the writer.
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.State">
- <summary>
- A <see cref="T:Alphaleonis.Win32.Vss.VssWriterState"/> value containing the state of the writer.
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.Failure">
- <summary>
- A <see cref="T:Alphaleonis.Win32.Vss.VssError"/> value indicating the failure code (if any) of the writer.
- </summary>
- <remarks>
- <para>
- The following are the supported values for <see cref="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.Failure"/>:
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Meaning</description>
- </listheader>
- <item>
- <term><see cref="F:Alphaleonis.Win32.Vss.VssError.Success"/></term>
- <description>The writer was successful.</description>
- </item>
- <item>
- <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterErrorInconsistentSnapshot"/></term>
- <description>The shadow copy contains only a subset of the volumes needed by the writer to correctly back up the application component.</description>
- </item>
- <item>
- <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterOutOfResources"/></term>
- <description>The writer ran out of memory or other system resources. The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.</description>
- </item>
- <item>
- <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterTimeout"/></term>
- <description>The writer operation failed because of a time-out between the Freeze and Thaw events. The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.</description>
- </item>
- <item>
- <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterErrorRetryable"/></term>
- <description>The writer failed due to an error that would likely not occur if the entire backup, restore, or shadow copy creation process was restarted. The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.</description>
- </item>
- <item>
- <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterErrorNonRetryable"/></term>
- <description>The writer operation failed because of an error that might recur if another shadow copy is created.</description>
- </item>
- <item>
- <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterNotResponding"/></term>
- <description>The writer is not responding.</description>
- </item>
- <item>
- <term><see cref="F:Alphaleonis.Win32.Vss.VssError.WriterStatusNotAvailable"/></term>
- <description>
- <para>
- The writer status is not available for one or more writers. A writer may have reached the maximum number of available backup and restore sessions.
- </para>
- <para>
- <b>Windows Vista, Windows Server 2003 and Windows XP:</b> This value is not supported.
- </para>
- </description>
- </item>
- </list>
- </para>
- </remarks>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.ApplicationErrorCode">
- <summary>
- Gets the return code that the writer passed for the <c>hrApplication</c> parameter of the <c>CVssWriterEx2::SetWriterFailureEx</c> method.
- </summary>
- <remarks>
- <note>This property requires Windows 7 or Windows Server 2008 R2 and will be <see langword="null"/> on earlier operating systems.</note>
- </remarks>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssWriterStatusInfo.ApplicationErrorMessage">
- <summary>
- Gets the application failure message that the writer passed for the <c>wszApplicationMessage</c> parameter of the <c>SetWriterFailureEx</c> method.
- </summary>
- <remarks>
- <note>This property requires Windows 7 or Windows Server 2008 R2 and will be <see langword="null"/> on earlier operating systems.</note>
- </remarks>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssUtils">
- <summary>
- The <see cref="T:Alphaleonis.Win32.Vss.VssUtils"/> class is a static utility class for accessing the platform specific
- instances of the various VSS interfaces in a platform-independent manner.
- </summary>
- <remarks>
- Use the <see cref="M:Alphaleonis.Win32.Vss.VssUtils.LoadImplementation"/> under normal circumstances to load
- the correct assembly and create an instance of <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> from that assembly. If you have
- specific requirements on how the assembly should be loaded, or the instance created you are not required to use
- these methods but can use the methods in this class for accessing the suggested assembly name to load, and load it manually.
- In this case you need to create an instance of the class called <c>Alphaleonis.Win32.Vss.VssImplementation</c> from the platform specific
- assembly. This class implements the <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> interface, and has a public parameterless constructor.
- </remarks>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssUtils.GetPlatformSpecificAssemblyShortName">
- <summary>
- Gets the short name of the platform specific assembly for the platform on which the assembly
- is currently executing.
- </summary>
- <returns>the short name of the platform specific assembly for the platform on which the assembly
- is currently executing.</returns>
- <exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The operating system could not be detected or is unsupported.</exception>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssUtils.GetPlatformSpecificAssemblyName">
- <summary>
- Gets the full name of the platform specific assembly for the platform on which the assembly is currently executing.
- </summary>
- <returns>The full name of the platform specific assembly for the platform on which the assembly is currently executing.</returns>
- <exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The operating system could not be detected or is unsupported.</exception>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssUtils.LoadImplementation">
- <summary>
- Loads the assembly containing the correct implementation of the <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> interface
- for the operating system on which the assembly is currently executing.
- </summary>
- <overloads>
- Loads the assembly containing the correct implementation of the <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> interface
- for the operating system on which the assembly is currently executing, optionally allowing the specification
- of an <see cref="T:System.AppDomain"/> into which to load the assembly.
- </overloads>
- <remarks>
- <para>
- The assembly will be loaded into the same <see cref="T:System.AppDomain"/> as the calling assembly.
- </para>
- <para>
- The assemblies are loaded using strong name lookup. They need to be present in the code base directory
- of the executing assembly, or installed in the GAC for the lookup to succeed.
- </para>
- </remarks>
-
- <returns>An newly created instance of <see cref="T:Alphaleonis.Win32.Vss.IVssImplementation"/> suitable for the
- operating system on which the assembly is currently executing.</returns>
- <exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The operating system could not be detected or is unsupported.</exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException">
- <summary>
- Exception thrown to indicate that the specified snapshot specifies a shadow copy that does not exist in the Backup Components Document.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException"/> class.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException"/> class.
- </summary>
- <param name="message">The message.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException"/> class.
- </summary>
- <param name="message">The message.</param>
- <param name="inner">The inner.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="info"/> parameter is <see langword="null"/>.
- </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">
- The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
- </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssProtectionLevel">
- <summary>
- Defines the set of volume shadow copy protection levels.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionLevel.OriginalVolume">
- <summary>
- Specifies that I/O to the original volume must be maintained at the expense of shadow copies.
- This is the default protection level. Shadow copies might be deleted if both of the following conditions occur:
- <list type="bullet">
- <item>
- <description>
- A write to the original volume occurs.
- </description>
- </item>
- <item>
- <description>
- The integrity of the shadow copy cannot be maintained for some reason, such as a failure to
- write to the shadow copy storage area or a failure to allocate sufficient memory.
- </description>
- </item>
- </list>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssProtectionLevel.Snapshot">
- <summary>
- Specifies that shadow copies must be maintained at the expense of I/O to the original volume.
- All I/O to the original volume will fail if both of the following conditions occur:
- <list type="bullet">
- <item>
- <description>
- A write to the original volume occurs.
- </description>
- </item>
- <item>
- <description>
- The corresponding write to the shadow copy storage area cannot be completed for some reason,
- such as a failure to write to the shadow copy storage area or a failure to allocate sufficient memory.
- </description>
- </item>
- </list>
- </summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssHardwareOptions">
- <summary>
- Defines shadow copy LUN flags.
- </summary>
- <remarks>
- Only supported on Windows Server 2008.
- </remarks>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.MaskLuns">
- <summary>
- The shadow copy LUN will be masked from the host.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.MakeReadWrite">
- <summary>
- The shadow copy LUN will be exposed to the host as a read-write volume.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.RevertIdentityAll">
- <summary>
- The disk identifiers of all of the shadow copy LUNs will be reverted to that of the
- original LUNs. However, if any of the original LUNs are present on the system, the operation will
- fail and none of the identifiers will be reverted.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.RevertIdentityNone">
- <summary>
- None of the disk identifiers of the shadow copy LUNs will be reverted.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.OnLunStateChangeNotifyReadWrite">
- <summary>
- The shadow copy LUNs will be converted permanently to read-write.
- This flag is set only as a notification for the provider; no provider action is required.
- For more information, see the <c>IVssHardwareSnapshotProviderEx::OnLunStateChange</c> method.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.OnLunStateChangeNotifyLunPreRecovery">
- <summary>
- The shadow copy LUNs will be converted temporarily to read-write and are about to undergo TxF recovery
- or VSS auto-recovery. This flag is set only as a notification for the provider; no provider action is required.
- For more information, see the <c>IVssHardwareSnapshotProviderEx::OnLunStateChange method</c>.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.OnLunStateChangeNotifyLunPostRecovery">
- <summary>
- The shadow copy LUNs have just undergone TxF recovery or VSS auto-recovery and have been converted back to
- read-only. This flag is set only as a notification for the provider; no provider action is required.
- For more information, see the <c>IVssHardwareSnapshotProviderEx::OnLunStateChange method</c>.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssHardwareOptions.OnLunStateChangeDoMaskLuns">
- <summary>
- The provider must mask shadow copy LUNs from this computer.
- For more information, see the <c>IVssHardwareSnapshotProviderEx::OnLunStateChange method</c>.
- </summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException">
- <summary>
- Exception indicating that the creation of a shadow copy is in progress, and only one shadow copy creation
- operation can be in progress at one time. Either wait to try again or return with a failure.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException"/>
- class with a system-supplied message describing the error.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotSetInProgressException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssSnapshotState">
- <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotState"/> enumeration is returned by a provider to specify the state of a given shadow copy operation.</summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Unknown">
- <summary><para>Reserved for system use.</para><para>Unknown shadow copy state.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Preparing">
- <summary><para>Reserved for system use.</para><para>Shadow copy is being prepared.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPrepare">
- <summary><para>Reserved for system use.</para><para>Processing of the shadow copy preparation is in progress.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Prepared">
- <summary><para>Reserved for system use.</para><para>Shadow copy has been prepared.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPreCommit">
- <summary><para>Reserved for system use.</para><para>Processing of the shadow copy precommit is in process.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.PreComitted">
- <summary><para>Reserved for system use.</para><para>Shadow copy is precommitted.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingCommit">
- <summary><para>Reserved for system use.</para><para>Processing of the shadow copy commit is in process.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Committed">
- <summary><para>Reserved for system use.</para><para>Shadow copy is committed.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPostCommit">
- <summary><para>Reserved for system use.</para><para>Processing of the shadow copy postcommit is in process.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPreFinalCommit">
- <summary><para>Reserved for system use.</para><para>Processing of the shadow copy file commit operation is underway.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.PreFinalCommitted">
- <summary><para>Reserved for system use.</para><para>Processing of the shadow copy file commit operation is done.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPostFinalCommit">
- <summary><para>Reserved for system use.</para><para>Processing of the shadow copy following the final commit and prior to shadow copy create is underway.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Created">
- <summary><para>Shadow copy is created.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Aborted">
- <summary><para>Reserved for system use.</para><para>Shadow copy creation is aborted.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Deleted">
- <summary><para>Reserved for system use.</para><para>Shadow copy has been deleted.</para></summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.PostCommitted">
- <summary><para>Reserved value.</para></summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssObjectType">
- <summary>
- The <see cref="T:Alphaleonis.Win32.Vss.VssObjectType"/> enumeration is used by requesters to identify an object as
- a shadow copy set, shadow copy, or provider.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssObjectType.Unknown">
- <summary>
- <para>
- The object type is not known.
- </para>
- <para>
- This indicates an application error.
- </para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssObjectType.None">
- <summary>
- <para>
- The interpretation of this value depends on whether it is used as an
- input to a VSS method or returned as an output from a VSS method.
- </para>
- <para>
- When used as an input to a VSS method, it indicates that the method is
- not restricted to any particular object type, but should act on all
- appropriate objects. In this sense, <see cref="F:Alphaleonis.Win32.Vss.VssObjectType.None"/> can be thought
- of as a wildcard input.
- </para>
- <para>
- When returned as an output, the object type is not known and means that
- there has been an application error.
- </para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssObjectType.SnapshotSet">
- <summary>Shadow copy set.</summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssObjectType.Snapshot">
- <summary>Shadow copy.</summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssObjectType.Provider">
- <summary>Shadow copy provider.</summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException">
- <summary>
- Exception indicating that the writer operation failed because of an error that might recur if another shadow copy is created.
- For more information, see <see href="http://msdn.microsoft.com/en-us/library/cc325736(VS.85).aspx">Event and Error Handling Under VSS</see>.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssNonRetryableWriterException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException"/> class.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssNonRetryableWriterException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException"/> class.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssNonRetryableWriterException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException"/> class.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssNonRetryableWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssNonRetryableWriterException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="info"/> parameter is <see langword="null"/>.
- </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">
- The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
- </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException">
- <summary>
- Exception indicating that the the shadow copy contains only a subset of the volumes needed by the writer to correctly back up the application component.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException"/> class.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException"/> class.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException"/> class.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="info"/> parameter is <see langword="null"/>.
- </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">
- The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
- </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssDifferencedFileInfo">
- <summary>
- Information about a file set (a specified file or files) to participate in an incremental or differential backup
- or restore as a differenced file, that is, backup and restores associated with it are to be implemented as if
- entire files are copied to and from backup media (as opposed to using partial files).
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.#ctor(System.String,System.String,System.Boolean,System.DateTime)">
- <summary>Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDifferencedFileInfo"/> class.</summary>
- <param name="path">The path to the differenced files.</param>
- <param name="fileSpecification">The file specification of the differenced files.</param>
- <param name="lastModifyTime">The time of last modification for the difference files.</param>
- <param name="isRecursive"><see langword="true"/> if the filespec for the differenced files should be interpreted recursively, <see langword="false"/> otherwise.</param>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.Path">
- <summary>
- <para>
- The path to the differenced files.
- </para>
- <para>
- Users of this method need to check to determine whether this path ends with a backslash (\).
- </para>
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.FileSpecification">
- <summary>The file specification of the differenced files.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.IsRecursive">
- <summary>
- Boolean specifying whether the file specification for the differenced files should be interpreted recursively.
- If <see langword="true"/>, then the entire directory hierarchy will need to be searched for files matching the
- file specification <see cref="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.FileSpecification"/> to find files to be handled as differenced files during incremental
- or differential backups. If <see langword="false"/>, only the root directory needs to be searched.
- </summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.LastModifyTime">
- <summary>
- The writer specification of the time of last modification for the difference files.
- </summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException">
- <summary>
- Exception thrown to indicate that the writer infrastructure is not operating properly.
- </summary>
- <remarks>
- Check that the Event Service and VSS have been started, and check for errors associated with those services in the error log.
- </remarks>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterInfrastructureException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException"/>
- class with a system-supplied message describing the error.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterInfrastructureException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterInfrastructureException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssWriterInfrastructureException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterInfrastructureException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException">
- <summary>
- Exception thrown to indicate that the volume is not supported by the specified provider.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException"/>
- class with a system-supplied message describing the error.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException">
- <summary>
- Exception thrown to indicate that the maximum number of volumes has been added to the shadow copy set.
- The specified volume was not added to the shadow copy set.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException"/>
- class with a system-supplied message describing the error.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssRestoreType">
- <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssRestoreType"/> enumeration is used by a requester to indicate the type of restore operation it is about to perform.</summary>
- <remarks>
- <para>A requester sets the type of a restore operation using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreState(Alphaleonis.Win32.Vss.VssRestoreType)"/>.</para>
- <!-- <para>A writer can retrieve the type of a restore operation by calling CVssWriter::GetRestoreType.</para> -->
- </remarks>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreType.Undefined">
- <summary>
- <para>No restore type is defined.</para>
- <para>This indicates an error on the part of the requester.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreType.ByCopy">
- <summary>The default restore type: A requester restores backed-up data to the original volume from a backup medium.</summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreType.Import">
- <summary>
- <para>
- A requester does not copy data from a backup medium, but imports a transportable shadow copy
- and uses this imported volume for operations such as data mining.
- </para>
- <para>
- <b>Windows Server 2003, Standard Edition and Windows Server 2003, Web Edition:</b> This value is not supported. All editions of Windows Server 2003 SP1 support this value.
- </para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRestoreType.Other">
- <summary>A restore type not currently enumerated. This value indicates an application error.</summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType">
- <summary>
- <para>
- The <see cref="T:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType"/> enumeration is used by writers to indicate their support of certain backup
- operations—such as incremental or differential backup—on the basis of file sets (a specified file or files).
- </para>
- <para>
- File sets stored in the Writer Metadata Document are tagged with a bit mask (or bitwise OR) of <see cref="T:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType"/>
- values indicating the following:
- <list type="bullet">
- <item>
- <description>
- Whether the writer and the requester have to
- evaluate a given file set for participation in the specified type of backup operations
- </description>
- </item>
- <item>
- <description>
- Whether backing up the specified file will require a shadow copy
- </description>
- </item>
- </list>
- </para>
- </summary>
- <remarks>
- For more information see the MSDN documentation on
- <see href="http://msdn.microsoft.com/en-us/library/aa384951(VS.85).aspx">VSS_FILE_SPEC_BACKUP_TYPE Enumeration</see>
- </remarks>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.Unknown">
- <summary>
- Used on operating systems where this enumeration is not supported, i.e. Windows XP.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.FullBackupRequired">
- <summary>
- <para>
- A file set tagged with this value must be involved in all types of backup operations.
- </para>
- <para>
- A writer tags a file set with this value to indicate to the requester that it expects a copy of the
- current version of the file set to be available following the restore of any backup operation
- with a <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of
- <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Full"/>.
- </para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.DifferentialBackupRequired">
- <summary>
- A writer tags a file set with this value to indicate to the requester that it
- expects a copy of the current version of the file set to be available following
- the restore of any backup operation with a <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of
- <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Differential"/>.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.IncrementalBackupRequired">
- <summary>
- A writer tags a file set with this value to indicate to the requester that it
- expects a copy of the current version of the file set to be available following the
- restore of any backup operation with a
- <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.LogBackupRequired">
- <summary>
- A writer tags a file set with this value to indicate to the requester that it
- expects a copy of the current version of the file set to be available following the
- restore of any backup operation with a
- <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Log"/>.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.FullSnapshotRequired">
- <summary>
- A file set tagged with this value must be backed up from a shadow copy of a volume
- (and never from the original volume) when participating in a backup operation with a
- <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Full"/>.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.DifferentialSnapshotRequired">
- <summary>
- A file set tagged with this value must be backed up from a shadow copy of a volume
- (and never from the original volume) when participating in a backup operation with a
- <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Differential"/>.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.IncrementalSnapshotRequired">
- <summary>
- A file set tagged with this value must be backed up from a shadow copy of a volume
- (and never from the original volume) when participating in a backup operation with a
- <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.LogSnapshotRequired">
- <summary>
- A file set tagged with this value must be backed up from a shadow copy of a volume
- (and never from the original volume) when participating in a backup operation with a
- <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Log"/>.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.AllBackupRequired">
- <summary>
- The default file backup specification type. A file set tagged with this value must always participate in backup and restore operations.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.AllSnapshotRequired">
- <summary>
- The shadow copy requirement for backup. A file set tagged with this value must always be backed up
- from a shadow copy of a volume (and never from the original volume) when participating in a backup operation.
- </summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssRebootRequiredException">
- <summary>
- <para>Exception thrown to indicate that the provider encountered an error that requires the user to restart the computer.</para>
- </summary>
- <remarks>
- <note><b>Windows Server 2003 and Windows XP:</b>This exception is not supported until Windows Vista.</note>
- </remarks>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssRebootRequiredException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException"/>
- class with a system-supplied message describing the error.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssRebootRequiredException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssRebootRequiredException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssRebootRequiredException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRebootRequiredException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssSnapshotCompatibility">
- <summary>
- The <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotCompatibility"/> enumeration indicates which volume control or file I/O operations are disabled for the
- volume that has been shadow copied.</summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotCompatibility.None">
- <summary>None of the other flags.</summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotCompatibility.DisableDefrag">
- <summary>The provider managing the shadow copies for a specified volume does not support defragmentation operations on that volume.</summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotCompatibility.DisableContentIndex">
- <summary>The provider managing the shadow copies for a specified volume does not support content index operations on that volume.</summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssProviderProperties">
- <summary>
- The <see cref="T:Alphaleonis.Win32.Vss.VssProviderProperties"/> class specifies shadow copy provider properties.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssProviderProperties.#ctor(System.Guid,System.String,Alphaleonis.Win32.Vss.VssProviderType,System.String,System.Guid,System.Guid)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderProperties"/> class.
- </summary>
- <param name="providerId">The provider id.</param>
- <param name="providerName">Name of the provider.</param>
- <param name="providerType">Type of the provider.</param>
- <param name="providerVersion">The provider version.</param>
- <param name="providerVersionId">The provider version id.</param>
- <param name="classId">The class id.</param>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderId">
- <summary>Identifies the provider who supports shadow copies of this class.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderName">
- <summary>The provider name.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderType">
- <summary>The provider type. See <see cref="T:Alphaleonis.Win32.Vss.VssProviderType"/> for more information.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderVersion">
- <summary>The provider version in readable format.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderVersionId">
- <summary>A <see cref="T:System.Guid"/> uniquely identifying the version of a provider.</summary>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ClassId">
- <summary>Class identifier of the component registered in the local machine's COM catalog.</summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssVolumeProperties">
- <summary>
- The <see cref="T:Alphaleonis.Win32.Vss.VssVolumeProperties"/> class contains the properties of a shadow copy source volume.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeProperties.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeProperties"/> class.
- </summary>
- <param name="volumeName">Name of the volume.</param>
- <param name="volumeDisplayName">Display name of the volume.</param>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssVolumeProperties.VolumeName">
- <summary>
- Gets the volume name, in <c>\\?\Volume{GUID}\</c> format.
- </summary>
- <value>The volume name, in <c>\\?\Volume{GUID}\</c> format.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssVolumeProperties.VolumeDisplayName">
- <summary>
- Gets a string that can be displayed to the user containing the shortest mount point (for example C:\).
- </summary>
- <value>A string that can be displayed to the user containing the shortest mount point (for example C:\).</value>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssDiffVolumeProperties">
- <summary>
- The <see cref="T:Alphaleonis.Win32.Vss.VssDiffVolumeProperties"/> structure describes a shadow copy storage area volume.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.#ctor(System.String,System.String,System.Int64,System.Int64)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDiffVolumeProperties"/> class.
- </summary>
- <param name="volumeName">Name of the volume.</param>
- <param name="volumeDisplayName">Display name of the volume.</param>
- <param name="volumeFreeSpace">The volume free space.</param>
- <param name="volumeTotalSpace">The volume total space.</param>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.VolumeName">
- <summary>
- Gets the shadow copy storage area volume name, in <c>\\?\Volume{GUID}\</c> format.
- </summary>
- <value>The shadow copy storage area volume name, in <c>\\?\Volume{GUID}\</c> format.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.VolumeDisplayName">
- <summary>
- Gets a string that can be displayed to a user, for example <c>C:\</c>, for the shadow copy storage area volume.
- </summary>
- <value>A string that can be displayed to a user, for example <c>C:\</c>, for the shadow copy storage area volume.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.VolumeFreeSpace">
- <summary>
- Gets the free space, in bytes, on the shadow copy storage area volume.
- </summary>
- <value>The free space, in bytes, on the shadow copy storage area volume.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDiffVolumeProperties.VolumeTotalSpace">
- <summary>
- Gets the total space, in bytes, on the shadow copy storage area volume.
- </summary>
- <value>The total space, in bytes, on the shadow copy storage area volume..</value>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException">
- <summary>
- Exception thrown to indicate that the requested identifier does not correspond to a registered provider.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException"/>
- class with a system-supplied message describing the error.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">
- <summary>
- Exception thrown to indicate that the requested object did not exists.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssObjectNotFoundException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"/>
- class with a system-supplied message describing the error.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssObjectNotFoundException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssObjectNotFoundException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssObjectNotFoundException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException">
- <summary>
- Exception thrown to indicate that the requested deletion of snapshots did not complete successfully.
- </summary>
- <remarks>
- To get further information about the cause of the error, check the inner exception which is populated with the
- original exception that caused the deletion to fail.
- </remarks>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class with the specified error message.
- </summary>
- <param name="message">The error message.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class with the specified error message and a reference
- to the exception causing this exception to be thrown.
- </summary>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor(System.Int32,System.Guid,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class, specifying the number of
- successfully deleted snapshots, the id of the snapshot on which the delete operation failed and the exception
- causing the delete operation to fail.
- </summary>
- <param name="deletedSnapshotsCount">The number of successfully deleted snapshots.</param>
- <param name="nonDeletedSnapshotId">The id of the non deleted snapshot, or <see cref="F:System.Guid.Empty"/> if such information is not available.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with information about the exception.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is a null reference (Nothing in Visual Basic). </exception>
- <PermissionSet>
- <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Read="*AllFiles*" PathDiscovery="*AllFiles*"/>
- <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="SerializationFormatter"/>
- </PermissionSet>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.DeletedSnapshotsCount">
- <summary>
- Gets the number of successfully deleted snapshots.
- </summary>
- <value>The number of successfully deleted snapshots.</value>
- </member>
- <member name="P:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.NonDeletedSnapshotId">
- <summary>
- Gets the non id of the snapshot that failed to be deleted.
- </summary>
- <value>The id of the snapshot that could not be deleted.</value>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssBadStateException">
- <summary>
- Exception class indicating that the vss object referenced was not in a correct state for the requested operation.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssBadStateException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssBadStateException"/> class.
- </summary>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssBadStateException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssBadStateException"/> class with the specified error message.
- </summary>
- <param name="message">The error message.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssBadStateException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssBadStateException"/> class with the specified error message
- and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message.</param>
- <param name="innerException">The inner exception.</param>
- </member>
- <member name="M:Alphaleonis.Win32.Vss.VssBadStateException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssBadStateException"/> class with serialized data.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes">
- <summary>
- Allows additional attributes to be specified for a shadow copy. The context of a shadow copy (as set by the SetContext method in <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> method)
- may be modified by a bitmask that contains a valid combination of <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> and
- <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> enumeration values.
- </summary>
- <remarks>In the VSS API, these values are represented by the enumeration
- <seealso cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> </remarks>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Persistent">
- <summary>The shadow copy is persistent across reboots.
- This attribute is automatically set for <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> contexts of <c>AppRollback</c>
- <c>ClientAccessible</c>, <c>ClientAccessibleWriters</c> and <c>NasRollback</c>.
- This attribute should not be used explicitly by requesters when setting the context of a shadow copy.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NoAutoRecovery">
- <summary>
- <para>Auto-recovery is disabled for the shadow copy.</para>
- <para>A requester can modify a shadow copy context with a bitwise OR of this attribute. By doing this, the requester instructs
- VSS to make the shadow copy read-only immediately after it is created, without allowing writers or other applications to update
- components in the shadow copy.</para>
- <para>Disabling auto-recovery can cause the shadow copy to be in an inconsistent state if any of its components are involved in
- transactional database operations, such as transactional read and write operations managed by Transactional NTFS (TxF).
- This is because disabling auto-recovery prevents incomplete transactions from being rolled back.</para>
- <para>Disabling auto-recovery also prevents writers from excluding files from the shadow copy. </para>
- <para><b>Windows Server 2003 and Windows XP:</b> This value is not supported until Windows Vista.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.ClientAccessible">
- <summary>
- <para>The specified shadow copy is a client-accessible copy, supports Shadow Copies for Shared Folders, and should not be exposed. </para>
- <para>This attribute is automatically set for <c>ClientAccessible</c> and <c>ClientAccessibleWriters</c>.</para>
- <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NoAutoRelease">
- <summary>
- <para>The shadow copy is not automatically deleted when the shadow copy requester process ends.
- The shadow copy can be deleted only by a call to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DeleteSnapshot(System.Guid,System.Boolean)"/> or
- <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DeleteSnapshotSet(System.Guid,System.Boolean)"/>.</para>
- <para>This attribute is automatically set for <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> contexts of <c>Rollback</c>,
- <c>ClientAccessible</c>, <c>ClientAccessibleWriters</c> and <c>Rollback</c>.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NoWriters">
- <summary>
- <para>No writers are involved in creating the shadow copy. </para>
- <para>This attribute is automatically set for <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> contexts of <c>NasRollback</c>,
- <c>FileShareBackup</c> and <c>ClientAccessible</c>.</para>
- <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Transportable">
- <summary>
- <para>The shadow copy is to be transported and therefore should not be surfaced locally. </para>
- <para>This attribute can be used explicitly by requesters when setting the context of a shadow copy, if the provider for
- shadow copy supports transportable shadow copies.</para>
- <para><b>Windows Server 2003, Standard Edition, Windows Server 2003, Web Edition, and Windows XP:</b> This attribute is not supported.
- All editions of Windows Server 2003 SP1 support this attribute.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NotSurfaced">
- <summary>
- <para>The shadow copy is not currently exposed. </para>
- <para>Unless the shadow copy is explicitly exposed or mounted, this attribute is set for all shadow copies.</para>
- <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.NotTransacted">
- <summary>
- <para>The shadow copy is not transacted.</para>
- <para>A requester can modify a shadow copy context with a bitwise OR of this attribute. By doing this, the requester instructs VSS to
- disable built-in integration between VSS and transaction and resource managers.</para>
- <para>Setting this attribute guarantees that the requester will not receive <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/> errors. However, it may
- cause unwanted consequences, such as the loss of transactional integrity or even data loss.</para>
- <para><b>Windows Server 2003 and Windows XP:</b> This value is not supported until Windows Vista.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.HardwareAssisted">
- <summary>
- <para>Indicates that a given provider is a hardware-based provider. </para>
- <para>This attribute is automatically set for hardware-based providers.</para>
- <para>This enumeration value cannot be used to manually set the context (using the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetContext(Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes)"/> method)
- of a shadow copy by a bit mask (or bitwise OR) of this enumeration value and a valid shadow copy context value from
- <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/>.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Differential">
- <summary>
- <para>Indicates that a given provider uses differential data or a copy-on-write mechanism to implement shadow copies. </para>
- <para>A requester can modify a shadow copy context with a bitwise OR of this attribute. By doing this, the requester instructs providers
- to create a shadow copy using a differential implementation. If no shadow copy provider installed on the system supports the
- requested attributes, a <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> error will be returned to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddToSnapshotSet(System.String,System.Guid)"/>.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Plex">
- <summary>
- <para>Indicates that a given provider uses a PLEX or mirrored split mechanism to implement shadow copies. </para>
- <para>A requester can modify a shadow copy context with a bitwise OR of this attribute. By doing this, the requester instructs the providers to create a shadow copy using a PLEX implementation. If no shadow copy provider installed on the system supports the requested
- attributes, a <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> error will be returned to <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddToSnapshotSet(System.String,System.Guid)"/>.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Imported">
- <summary>
- <para>The shadow copy of the volume was imported onto this machine using the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.ImportSnapshots"/> method
- rather than created using the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DoSnapshotSet"/> method. </para>
- <para>This attribute is automatically set if a shadow copy is imported.</para>
- <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.ExposedLocally">
- <summary>
- <para>The shadow copy is locally exposed. If this bit flag and the <c>ExposedRemotely</c> bit flag are not set,
- the shadow copy is hidden. </para>
- <para>The attribute is automatically added to a shadow copy context upon calling the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.ExposeSnapshot(System.Guid,System.String,Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes,System.String)"/>
- method to expose a shadow copy locally.</para>
- <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.ExposedRemotely">
- <summary>
- <para>The shadow copy is remotely exposed. If this bit flag and the <c>ExposedLocally</c> bit flag are not set, the shadow copy is hidden. </para>
- <para>The attribute is automatically added to a shadow copy context upon calling the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.ExposeSnapshot(System.Guid,System.String,Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes,System.String)"/>
- method to expose a shadow copy locally.</para>
- <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.AutoRecover">
- <summary>
- <para>Indicates that the writer will need to auto-recover the component in <c>CVssWriter::OnPostSnapshot</c>. </para>
- <para>This attribute should not be used explicitly by requesters when setting the context of a shadow copy.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.RollbackRecovery">
- <summary>
- <para>Indicates that the writer will need to auto-recover the component in <c>CVssWriter::OnPostSnapshot</c> if the shadow copy is being used
- for rollback (for data mining, for example). </para>
- <para>A requester would set this flag in the shadow copy context to indicate that the shadow copy is being created for a non-backup
- purpose such as data mining.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.DelayedPostSnapshot">
- <summary>
- <para>Reserved for system use.</para>
- <para><b>Windows Vista, Windows Server 2003, and Windows XP:</b> This value is not supported until Windows Server 2008.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.TxFRecovery">
- <summary>
- <para>Indicates that TxF recovery should be enforced during shadow copy creation.</para>
- <para><b>Windows Vista, Windows Server 2003, and Windows XP:</b> This value is not supported until Windows Server 2008.</para>
- </summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssSnapshotContext">
- <summary>
- The <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> enumeration enables a requester using <see cref="O:Alphaleonis.Win32.Vss.IVssBackupComponents.SetContext"/> to specify how a
- shadow copy is to be created, queried, or deleted and the degree of writer involvement.
- <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>::SetContext" method) may be modified by a bitmask that contains a valid combination of
- <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> and <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> enumeration values.
- </summary>
- <remarks><see cref="T:Alphaleonis.Win32.Vss.VssSnapshotContext"/> is defined as a static class defining the base <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/>
- combination of values representing the VSS_CTX_XXXXXX constants defined in the VSS API.
- </remarks>
- <seealso cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.Backup">
- <summary>
- The standard backup context. Specifies an auto-release, nonpersistent shadow copy in which writers are involved in the creation.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.FileShareBackup">
- <summary>
- Specifies a nonpersistent and auto-release shadow copy created without writer involvement.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.NasRollback">
- <summary>
- <para>Specifies a persistent and non-auto-release shadow copy without writer involvement. This context should be used when there is no need for writer involvement to ensure that files are in a consistent state at the time of the shadow copy. </para>
- <para>Lightweight automated file rollback mechanisms or persistent shadow copies of file shares or data volumes that are not expected to contain any system-related files or databases might run under this context. For example, a requester could use this context for creating a shadow copy of a NAS volume hosting documents and simple user shares. Those types of data do not need writer involvement to create a consistent shadow copy.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.AppRollback">
- <summary>
- <para>Specifies a persistent and non-auto-release shadow copy with writer involvement. This context is designed to be used when writers are needed to ensure that files are in a well-defined state prior to shadow copy. </para>
- <para>Automated file rollback mechanisms of system volumes and shadow copies to be used in data mining or restore operations might run under this context. This context is similar to VSS_CTX_BACKUP but allows a requester more control over the persistence of the shadow copy.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.ClientAccessible">
- <summary>
- <para>Specifies a read-only, client-accessible shadow copy supporting Shadow Copies for Shared Folders and created without writer involvement. Only the system provider (the default provider available on the system) can create this type of shadow copy. </para>
- <para>Most requesters will want to use the <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.NasRollback"/> context for persistent, non-auto-release shadow copies without writer involvement.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.ClientAccessibleWriters">
- <summary>
- <para>Specifies a read-only, client-accessible shadow copy supporting Shadow Copies for Shared Folders and created with writer involvement. Only the system provider (the default provider available on the system) can create this type of shadow copy. </para>
- <para>Most requesters will want to use the <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.AppRollback"/> context for persistent, non-auto-release shadow copies with writer involvement.</para>
- <para><b>Windows Server 2003 and Windows XP:</b> This context is not supported by Windows Server 2003 and Windows XP.</para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssSnapshotContext.All">
- <summary>
- All types of currently live shadow copies are available for administrative operations, such as shadow copy queries
- (see the Query method in <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>). <see cref="F:Alphaleonis.Win32.Vss.VssSnapshotContext.All"/> is a valid context for all VSS interfaces except
- <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>::StartSnapshotSet and <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/>::DoSnapshotSet.
- </summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus">
- <summary>
- The <see cref="T:Alphaleonis.Win32.Vss.VssFileRestoreStatus"/> enumeration defines the set of statuses of a file restore operation performed on
- the files managed by a selected component or component set.
- </summary>
- <remarks>
- See MSDN documentation on <c>VSS_FILE_RESTORE_STATUS</c> for more information.
- </remarks>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.Undefined">
- <summary>
- <para>
- The restore state is undefined.
- </para>
- <para>
- This value indicates an error, or indicates that a restore operation has not yet started.
- </para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.None">
- <summary>
- <para>
- No files were restored.
- </para>
- <para>
- This value indicates an error in restoration that did not leave any restored files on disk.
- </para>
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.All">
- <summary>
- All files were restored. This value indicates success and should be set for each component that was restored successfully.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssFileRestoreStatus.Failed">
- <summary>
- <para>
- The restore process failed.
- </para>
- <para>
- This value indicates an error in restoration that did leave some restored files on disk. This means the components on disk are now corrupt.
- </para>
- </summary>
- </member>
- <member name="T:Alphaleonis.Win32.Vss.VssRecoveryOptions">
- <summary>
- Used by a requester to specify how a resynchronization operation is to be performed.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRecoveryOptions.None">
- <summary>
- No options.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRecoveryOptions.RevertIdentityAll">
- <summary>
- After the resynchronization operation is complete, the signature of each target LUN should be identical to that of the original LUN that was used to create the shadow copy.
- </summary>
- </member>
- <member name="F:Alphaleonis.Win32.Vss.VssRecoveryOptions.NoVolumeCheck">
- <summary>
- Volume safety checks should not be performed.
- </summary>
- </member>
<member name="T:Alphaleonis.Win32.Vss.IVssBackupComponents">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.IVssBackupComponents"/> class is used by a requester to poll writers about file status and to run backup/restore operations.
@@ -6825,40 +5742,71 @@ <exception cref="T:Alphaleonis.Win32.Vss.VssBadStateException">The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence.</exception>
<exception cref="T:Alphaleonis.Win32.Vss.VssObjectNotFoundException">The specified shadow copy does not exist.</exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException">
+ <member name="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">
<summary>
- Exception thrown to indicate that the system was unable to freeze the Distributed Transaction Coordinator (DTC)
- or the Kernel Transaction Manager (KTM).
+ Exception thrown to indicate that the provider returned an unexpected error code. This can be a transient problem.
</summary>
<remarks>
- <note>
- <b>Windows Server 2003 and Windows XP:</b> This exception is not supported until Windows Vista.
- </note>
+ It is recommended to wait ten minutes and try again, up to three times.
</remarks>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException.#ctor">
+ <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException.#ctor">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException"/>
class with a system-supplied message describing the error.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException.#ctor(System.String)">
+ <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException.#ctor(System.String)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/> class with a specified error message.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException.#ctor(System.String,System.Exception)">
+ <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException.#ctor(System.String,System.Exception)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/> class with
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionFreezeTimeoutException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException">
+ <summary>
+ Exception thrown to indicate that the requested identifier does not correspond to a registered provider.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException"/>
+ class with a system-supplied message describing the error.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException"/> class with a specified error message.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderNotRegisteredException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
@@ -6936,602 +5884,917 @@ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssProviderType">
- <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssProviderType"/> enumeration specifies the provider type.</summary>
+ <member name="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException">
+ <summary>
+ Exception thrown to indicate that the requested deletion of snapshots did not complete successfully.
+ </summary>
+ <remarks>
+ To get further information about the cause of the error, check the inner exception which is populated with the
+ original exception that caused the deletion to fail.
+ </remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProviderType.Unknown">
+ <member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor">
<summary>
- <para>
- The provider type is unknown.
- </para>
- <para>
- This indicates an error in the application or the VSS service, or that no provider is available.
- </para>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProviderType.System">
- <summary>The default provider that ships with Windows.</summary>
+ <member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class with the specified error message.
+ </summary>
+ <param name="message">The error message.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProviderType.Software">
- <summary>A software-based provider.</summary>
+ <member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class with the specified error message and a reference
+ to the exception causing this exception to be thrown.
+ </summary>
+ <param name="message">The error message.</param>
+ <param name="innerException">The inner exception.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssProviderType.Hardware">
- <summary>A hardware-based provider.</summary>
+ <member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor(System.Int32,System.Guid,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class, specifying the number of
+ successfully deleted snapshots, the id of the snapshot on which the delete operation failed and the exception
+ causing the delete operation to fail.
+ </summary>
+ <param name="deletedSnapshotsCount">The number of successfully deleted snapshots.</param>
+ <param name="nonDeletedSnapshotId">The id of the non deleted snapshot, or <see cref="F:System.Guid.Empty"/> if such information is not available.</param>
+ <param name="innerException">The inner exception.</param>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssPartialFileInfo">
+ <member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- Representation of information on a partial file associated with a component.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException"/> class.
</summary>
- <remarks>See <see href="http://msdn.microsoft.com/en-us/library/aa383529(VS.85).aspx">MSDN documentation on IVssComponent::GetPartialFile Method</see> for more information.</remarks>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssPartialFileInfo.#ctor(System.String,System.String,System.String,System.String)">
- <summary>Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFileInfo"/> class</summary>
- <param name="path">The path of the partial file.</param>
- <param name="fileName">The name of the partial file.</param>
- <param name="range">Either a listing of file offsets and lengths that make up the partial file support range
- (the sections of the file that were backed up), or the name of a file containing such a list.</param>
- <param name="metadata">Any additional metadata required by a writer to validate a partial file restore operation. The information in this
- metadata string will be opaque to requesters. May be <see langword="null"/></param>
+ <member name="M:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with information about the exception.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is a null reference (Nothing in Visual Basic). </exception>
+ <PermissionSet>
+ <IPermission class="System.Security.Permissions.FileIOPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Read="*AllFiles*" PathDiscovery="*AllFiles*"/>
+ <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="SerializationFormatter"/>
+ </PermissionSet>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.Path">
+ <member name="P:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.DeletedSnapshotsCount">
<summary>
- <para>
- The path of the partial file.
- </para>
- <para>
- Users of this public need to check to determine whether this path ends with a backslash ("\").
- </para>
+ Gets the number of successfully deleted snapshots.
</summary>
+ <value>The number of successfully deleted snapshots.</value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.FileName">
- <summary>The name of the partial file.</summary>
+ <member name="P:Alphaleonis.Win32.Vss.VssDeleteSnapshotsFailedException.NonDeletedSnapshotId">
+ <summary>
+ Gets the non id of the snapshot that failed to be deleted.
+ </summary>
+ <value>The id of the snapshot that could not be deleted.</value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.Range">
+ <member name="T:Alphaleonis.Win32.Vss.VssObjectType">
<summary>
- Either a listing of file offsets and lengths that make up the partial file support range
- (the sections of the file that were backed up), or the name of a file containing such a list.
+ The <see cref="T:Alphaleonis.Win32.Vss.VssObjectType"/> enumeration is used by requesters to identify an object as
+ a shadow copy set, shadow copy, or provider.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.Metadata">
+ <member name="F:Alphaleonis.Win32.Vss.VssObjectType.Unknown">
<summary>
<para>
- Any additional metadata required by a writer to validate a partial file restore operation. The information in this
- metadata string will be opaque to requesters.
+ The object type is not known.
</para>
<para>
- Additional metadata is not required, so <see cref="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.Metadata"/> may also be empty (zero length).
+ This indicates an application error.
</para>
</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssError">
+ <member name="F:Alphaleonis.Win32.Vss.VssObjectType.None">
<summary>
<para>
- The <see cref="T:Alphaleonis.Win32.Vss.VssError"/> enumeration represents error- and success codes that may be
- returned by some Vss methods.
+ The interpretation of this value depends on whether it is used as an
+ input to a VSS method or returned as an output from a VSS method.
+ </para>
+ <para>
+ When used as an input to a VSS method, it indicates that the method is
+ not restricted to any particular object type, but should act on all
+ appropriate objects. In this sense, <see cref="F:Alphaleonis.Win32.Vss.VssObjectType.None"/> can be thought
+ of as a wildcard input.
+ </para>
+ <para>
+ When returned as an output, the object type is not known and means that
+ there has been an application error.
</para>
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.Success">
- <summary>Indication of a successful operation.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssObjectType.SnapshotSet">
+ <summary>Shadow copy set.</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.AsyncCanceled">
+ <member name="F:Alphaleonis.Win32.Vss.VssObjectType.Snapshot">
+ <summary>Shadow copy.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssObjectType.Provider">
+ <summary>Shadow copy provider.</summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException">
<summary>
- The asynchronous operation was cancelled.
+ Exception indicating that the writer ran out of memory or other system resources.
+ The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.AsyncFinished">
+ <member name="T:Alphaleonis.Win32.Vss.VssRetryableWriterException">
<summary>
- The asynchronous operation was completed successfully.
+ Exception indicating that the writer failed due to an error that would likely not occur if the entire backup, restore, or
+ shadow copy creation process was restarted. The recommended way to handle this error is to wait ten minutes and then
+ repeat the operation, up to three times.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.AsyncPending">
+ <member name="M:Alphaleonis.Win32.Vss.VssRetryableWriterException.#ctor">
<summary>
- The asynchronous operation is still running.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRetryableWriterException"/> class.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.Unexpected">
+ <member name="M:Alphaleonis.Win32.Vss.VssRetryableWriterException.#ctor(System.String)">
<summary>
- Unexpected error. The error code is logged in the error log file.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRetryableWriterException"/> class.
</summary>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.BadState">
+ <member name="M:Alphaleonis.Win32.Vss.VssRetryableWriterException.#ctor(System.String,System.Exception)">
<summary>
- A method call was made when the object was in an incorrect state
- for that method.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRetryableWriterException"/> class.
</summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.ProviderAlreadyRegistered">
+ <member name="M:Alphaleonis.Win32.Vss.VssRetryableWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- The provider has already been registered.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRetryableWriterException"/> class.
</summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">
+ The <paramref name="info"/> parameter is <see langword="null"/>.
+ </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">
+ The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
+ </exception>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.ProviderNotRegistered">
+ <member name="M:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException.#ctor">
<summary>
- The specified identifier does not correspond to a registered provider.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException"/> class.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.ProviderVeto">
+ <member name="M:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException.#ctor(System.String)">
<summary>
- The provider was unable to perform the request at this time. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException"/> class.
</summary>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.ProviderInUse">
+ <member name="M:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException.#ctor(System.String,System.Exception)">
<summary>
- The shadow copy provider is currently in use and cannot be unregistered.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException"/> class.
</summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.ObjectNotFound">
+ <member name="M:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- The specified object was not found.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssOutOfResourcesWriterException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">
+ The <paramref name="info"/> parameter is <see langword="null"/>.
+ </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">
+ The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
+ </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException">
+ <summary>
+ Exception indicating that the resynchronization destination contained a volume that was not explicitly included.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.VolumeNotSupported">
+ <member name="M:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException.#ctor">
<summary>
- No VSS provider indicates that it supports the specified volume.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException"/> class.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.VolumeNotSupportedByProvider">
+ <member name="M:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException.#ctor(System.String)">
<summary>
- The volume is not supported by the specified provider.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException"/> class.
</summary>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.ObjectAlreadyExists">
+ <member name="M:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException.#ctor(System.String,System.Exception)">
<summary>
- The object already exists.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException"/> class.
</summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.UnexpectedProviderError">
+ <member name="M:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- The provider returned an unexpected error code. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException"/> class.
</summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">
+ The <paramref name="info"/> parameter is <see langword="null"/>.
+ </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">
+ The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
+ </exception>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.InvalidXmlDocument">
+ <member name="T:Alphaleonis.Win32.Vss.VssDiffAreaProperties">
<summary>
- The given XML document is invalid. It is either incorrectly-formed XML or it does not match the schema.
+ The <see cref="T:Alphaleonis.Win32.Vss.VssDiffAreaProperties"/> structure describes associations between volumes containing the original file data
+ and volumes containing the shadow copy storage area (also known as the diff area).
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.MaximumNumberOfVolumesReached">
+ <member name="M:Alphaleonis.Win32.Vss.VssDiffAreaProperties.#ctor(System.String,System.String,System.Int64,System.Int64,System.Int64)">
<summary>
- The maximum number of volumes has been added to the shadow copy set. The specified volume was not added to the shadow copy set.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDiffAreaProperties"/> class.
</summary>
+ <param name="volumeName">Name of the volume.</param>
+ <param name="diffAreaVolumeName">Name of the diff area volume.</param>
+ <param name="maximumDiffSpace">The maximum diff space.</param>
+ <param name="allocatedDiffSpace">The allocated diff space.</param>
+ <param name="usedDiffSpace">The used diff space.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.UnexpectedWriterError">
+ <member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.VolumeName">
<summary>
- VSS encountered problems while sending events to writers.
+ Gets the original volume name.
</summary>
+ <value>The original volume name.</value>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.SnapshotSetInProgress">
+ <member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.DiffAreaVolumeName">
<summary>
- Another shadow copy creation is already in progress. Please wait a few moments and try again.
- </summary>
+ Gets the shadow copy storage area volume name.
+ </summary>
+ <value>The shadow copy storage area volume name.</value>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.MaximumNumberOfSnapshotsReached">
+ <member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.MaximumDiffSpace">
<summary>
- The volume has been added to the maximum number of shadow copy sets. The specified volume was not added to the shadow copy set.
+ Gets the maximum space used on the shadow copy storage area volume for this association.
</summary>
+ <value>The maximum space used on the shadow copy storage area volume for this association.</value>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.WriterInfrastructureError">
+ <member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.AllocatedDiffSpace">
<summary>
- An error was detected in the Volume Shadow Copy Service (VSS). The problem occurred while trying to contact VSS writers.
- Please verify that the Event System service and the VSS service are running and check for associated errors in the event logs.
+ Gets the allocated space on the shadow copy storage area volume by this association.
+ This must be less than or equal to <see cref="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.MaximumDiffSpace"/>.
</summary>
+ <value>The allocated space on the shadow copy storage area volume by this association.</value>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.WriterNotResponding">
+ <member name="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.UsedDiffSpace">
<summary>
- A writer did not respond to a GatherWriterStatus call. The writer may either have terminated
- or it may be stuck. Check the system and application event logs for more information.
+ Gets the used space from the allocated area. This must be less than or equal to <see cref="P:Alphaleonis.Win32.Vss.VssDiffAreaProperties.AllocatedDiffSpace"/>.
</summary>
+ <value>The the used space from the allocated area.</value>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.WriterAlreadySubscribed">
+ <member name="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException">
<summary>
- The writer has already sucessfully called the Subscribe function. It cannot call
- subscribe multiple times.
+ Exception indicating that the writer status is not available for one or more writers.
+ A writer may have reached the maximum number of available backup and restore sessions.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.UnsupportedContext">
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException.#ctor">
<summary>
- The shadow copy provider does not support the specified shadow copy type.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException"/> class.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.VolumeInUse">
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException.#ctor(System.String)">
<summary>
- The specified shadow copy storage association is in use and so can't be deleted.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException"/> class.
</summary>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.MaximumDiffareaAssociationsReached">
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException.#ctor(System.String,System.Exception)">
<summary>
- Maximum number of shadow copy storage associations already reached.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException"/> class.
</summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.InsufficientStorage">
+ <member name="M:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- The system or provider has insufficient storage space. If possible delete any old or unnecessary persistent shadow copies and try again.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWriterStatusNotAvailableException"/> class.
</summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">
+ The <paramref name="info"/> parameter is <see langword="null"/>.
+ </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">
+ The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
+ </exception>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.NoSnapshotsImported">
+ <member name="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException">
<summary>
- No shadow copies were successfully imported.
+ Exception thrown to indicate that the maximum number of volumes has been added to the shadow copy set.
+ The specified volume was not added to the shadow copy set.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.SomeSnapshotsNotImportedSuccess">
+ <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException.#ctor">
<summary>
- Some shadow copies were not succesfully imported.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException"/>
+ class with a system-supplied message describing the error.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.SomeSnapshotsNotImportedError">
+ <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException.#ctor(System.String)">
<summary>
- Some shadow copies were not succesfully imported.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException"/> class with a specified error message.
</summary>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.MaximumNumberOfRemoteMachinesReached">
+ <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException.#ctor(System.String,System.Exception)">
<summary>
- The maximum number of remote machines for this operation has been reached.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.RemoteServerUnavailable">
+ <member name="M:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- The remote server is unavailable.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumNumberOfSnapshotsReachedException"/> class.
</summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.RemoteServerUnsupported">
+ <member name="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException">
<summary>
- The remote server is running a version of the Volume Shadow Copy Service that does not
- support remote shadow-copy creation.
+ Exception thrown to indicate that the operation is not supported under the current context.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.RevertInProgress">
+ <member name="M:Alphaleonis.Win32.Vss.VssUnsupportedContextException.#ctor">
<summary>
- A revert is currently in progress for the specified volume. Another revert
- cannot be initiated until the current revert completes.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException"/>
+ class with a system-supplied message describing the error.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.RevertVolumeLost">
+ <member name="M:Alphaleonis.Win32.Vss.VssUnsupportedContextException.#ctor(System.String)">
<summary>
- The volume being reverted was lost during revert.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException"/> class with a specified error message.
</summary>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.RebootRequired">
+ <member name="M:Alphaleonis.Win32.Vss.VssUnsupportedContextException.#ctor(System.String,System.Exception)">
<summary>
- <para>The provider encountered an error that requires the user to restart the computer.</para>
- <para><b>Windows Server 2003 and Windows XP:</b>This value is not supported until Windows Vista.</para>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.TransactionFreezeTimeout">
+ <member name="M:Alphaleonis.Win32.Vss.VssUnsupportedContextException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- <para>The system was unable to freeze the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).</para>
- <para><b>Windows Server 2003 and Windows XP:</b>This value is not supported until Windows Vista.</para>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException"/> class.
</summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.TransactionThawTimeout">
+ <member name="T:Alphaleonis.Win32.Vss.VssUnexpectedErrorException">
<summary>
- <para>The system was unable to thaw the Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).</para>
- <para><b>Windows Server 2003 and Windows XP:</b>This value is not supported until Windows Vista.</para>
+ Exception class indicating that an unexpected error occured. The error code is logged in the error log file.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.WriterErrorInconsistentSnapshot">
+ <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedErrorException.#ctor">
<summary>
- The shadow copy contains only a subset of the volumes needed by the writer to correctly back
- up the application component.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssException"/> class.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.WriterOutOfResources">
+ <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedErrorException.#ctor(System.String)">
<summary>
- The writer ran out of memory or other system resources. The recommended way to handle this error code is
- to wait ten minutes and then repeat the operation, up to three times.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedErrorException"/> class with the specified error message.
</summary>
+ <param name="message">The error message.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.WriterTimeout">
+ <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedErrorException.#ctor(System.String,System.Exception)">
<summary>
- The writer operation failed because of a time-out between the Freeze and Thaw events.
- The recommended way to handle this error code is to wait ten minutes and then repeat the operation, up to three times.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedErrorException"/> class with the specified error message
+ and a reference to the inner exception that is the cause of this exception.
</summary>
+ <param name="message">The error message.</param>
+ <param name="innerException">The inner exception.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.WriterErrorRetryable">
+ <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedErrorException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- The writer failed due to an error that would likely not occur if the entire backup, restore, or shadow copy creation
- process was restarted. The recommended way to handle this error code is to wait ten minutes and then repeat
- the operation, up to three times.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedErrorException"/> class with serialized data.
</summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.WriterErrorNonRetryable">
+ <member name="T:Alphaleonis.Win32.Vss.VssResyncInProgressException">
<summary>
- The writer experienced a non-transient error. If the backup process is retried,
- the error is likely to reoccur.
+ Exception thrown to indicate that another LUN resynchronization operation is already in progress.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.WriterErrorRecoveryFailed">
+ <member name="M:Alphaleonis.Win32.Vss.VssResyncInProgressException.#ctor">
<summary>
- The writer experienced an error while trying to recover the shadow-copy volume.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssResyncInProgressException"/> class.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.BreakRevertIdFailed">
+ <member name="M:Alphaleonis.Win32.Vss.VssResyncInProgressException.#ctor(System.String)">
<summary>
- The shadow copy set break operation failed because the disk/partition identities could not be reverted.
- The target identity already exists on the machine or cluster and must be masked before this operation can succeed.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssResyncInProgressException"/> class.
</summary>
+ <param name="message">The message.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.LegacyProvider">
+ <member name="M:Alphaleonis.Win32.Vss.VssResyncInProgressException.#ctor(System.String,System.Exception)">
<summary>
- This version of the hardware provider does not support this operation.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssResyncInProgressException"/> class.
</summary>
+ <param name="message">The message.</param>
+ <param name="inner">The inner.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.BreakFailFromProvider">
+ <member name="M:Alphaleonis.Win32.Vss.VssResyncInProgressException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- At least one of the providers in this Shadow Copy Set failed the break operation for a snapshot.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssResyncInProgressException"/> class.
</summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">
+ The <paramref name="info"/> parameter is <see langword="null"/>.
+ </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">
+ The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
+ </exception>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.AsrDiskAssignmentFailed">
+ <member name="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException">
<summary>
- There are too few disks on this computer or one or more of the disks is too small.
- Add or change disks so they match the disks in the backup, and try the restore again.
+ Exception indicating that the the shadow copy contains only a subset of the volumes needed by the writer to correctly back up the application component.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.AsrDiskRecreationFailed">
+ <member name="M:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException.#ctor">
<summary>
- Windows cannot create a disk on this computer needed to restore from the backup.
- Make sure the disks are properly connected, or add or change disks, and try the restore again.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException"/> class.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.AsrNoArcPath">
+ <member name="M:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException.#ctor(System.String)">
<summary>
- The computer needs to be restarted to finish preparing a hard disk for restore. To continue, restart your computer and run the restore again.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException"/> class.
</summary>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.AsrMissingDynamicDisk">
+ <member name="M:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException.#ctor(System.String,System.Exception)">
<summary>
- The backup failed due to a missing disk for a dynamic volume. Please ensure the disk is online and retry the backup.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException"/> class.
</summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.AsrSharedCriticalDiskError">
+ <member name="M:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- Automated System Recovery failed the shadow copy, because a selected critical volume is located on a cluster shared disk.
- This is an unsupported configuration.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInconsistentSnapshotWriterException"/> class.
</summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">
+ The <paramref name="info"/> parameter is <see langword="null"/>.
+ </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">
+ The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
+ </exception>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.AsrDatadiskRdisk0">
+ <member name="T:Alphaleonis.Win32.Vss.VssRollForwardType">
<summary>
- A data disk is currently set as active in BIOS. Set some other disk as active or use the DiskPart utility to clean the
- data disk, and then retry the restore operation.
+ The <c>VssRollForwardType</c> enumeration is used by a requester to indicate the type of roll-forward operation it is about to perform.
</summary>
+ <remarks>
+ A requester sets the roll-forward operation type and specifies the restore point for partial roll-forward operations
+ using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRollForward(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,Alphaleonis.Win32.Vss.VssRollForwardType,System.String)"/>.
+ </remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.AsrRdisk0TooSmall">
+ <member name="F:Alphaleonis.Win32.Vss.VssRollForwardType.Undefined">
<summary>
- The disk that is set as active in BIOS is too small to recover the original system disk.
- Replace the disk with a larger one and retry the restore operation.
+ <para>
+ No roll-forward type is defined.
+ </para>
+ <para>
+ This indicates an error on the part of the requester.
+ </para>
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.AsrCriticalDisksTooSmall">
+ <member name="F:Alphaleonis.Win32.Vss.VssRollForwardType.None">
<summary>
- There is not enough disk space on the system to perform the restore operation.
- Add another disk or replace one of the existing disks and retry the restore operation.
+ The roll-forward operation should not roll forward through logs.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.WriterStatusNotAvailable">
+ <member name="F:Alphaleonis.Win32.Vss.VssRollForwardType.All">
+ <summary>
+ The roll-forward operation should roll forward through all logs.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssRollForwardType.Partial">
+ <summary>
+ The roll-forward operation should roll forward through logs up to a specified restore point.
+ </summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssSnapshotProperties">
+ <summary>
+ The <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotProperties"/> class contains the properties of a shadow copy or shadow copy set.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssSnapshotProperties.#ctor(System.Guid,System.Guid,System.Int64,System.String,System.String,System.String,System.String,System.String,System.String,System.Guid,Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes,System.DateTime,Alphaleonis.Win32.Vss.VssSnapshotState)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotProperties"/> class.
+ </summary>
+ <param name="snapshotId">The snapshot id.</param>
+ <param name="snapshotSetId">The snapshot set id.</param>
+ <param name="snapshotCount">The snapshot count.</param>
+ <param name="snapshotDeviceObject">The snapshot device object.</param>
+ <param name="originalVolumeName">Name of the original volume.</param>
+ <param name="originatingMachine">The originating machine.</param>
+ <param name="serviceMachine">The service machine.</param>
+ <param name="exposedName">Name of the exposed.</param>
+ <param name="exposedPath">The exposed path.</param>
+ <param name="providerId">The provider id.</param>
+ <param name="snapshotAttributes">The snapshot attributes.</param>
+ <param name="creationTimestamp">The creation timestamp.</param>
+ <param name="snapshotState">State of the snapshot.</param>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotId">
+ <summary>A <see cref="T:System.Guid"/> uniquely identifying the shadow copy identifier.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotSetId">
+ <summary>A <see cref="T:System.Guid"/> uniquely identifying the shadow copy set containing the shadow copy.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotsCount">
<summary>
<para>
- The writer status is not available for one or more writers. A writer may have reached the maximum number of available backup
- and restore sessions.
+ Number of volumes included with the shadow copy in the shadow copy set when it was created.
+ Because it is possible for applications to release individual shadow copies without releasing the shadow copy
+ set, at any given time the number of shadow copies in the shadow copy set may be less than <see cref="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotsCount"/>
</para>
<para>
- <b>Windows Vista, Windows Server 2003, and Windows XP:</b> This value is not supported.
+ The maximum number of shadow-copied volumes permitted in a shadow copy set is 64.
</para>
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.FlushWritesTimeout">
+ <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotDeviceObject">
<summary>
- The system was unable to flush I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
+ <para>
+ The name of the device object for the shadow copy of the volume. The device object can be thought of as
+ the root of a shadow copy of a volume. Requesters will use this device name when accessing files on a
+ shadow-copied volume that it needs to work with.
+ </para>
+ <para>
+ The device name does not contain a trailing "\".
+ </para>
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssError.HoldWritesTimeout">
+ <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.OriginalVolumeName">
+ <summary>The name of the volume that had been shadow copied.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.OriginatingMachine">
+ <summary>The name of the machine containing the original volume.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.ServiceMachine">
+ <summary>The name of the machine running the Volume Shadow Copy Service that created the shadow copy.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.ExposedName">
+ <summary>The name of the shadow copy when it is exposed. This is a drive letter or mount point (if the shadow copy is exposed as a local volume), or a share name. </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.ExposedPath">
+ <summary>The portion of the shadow copy of a volume made available if it is exposed as a share.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.ProviderId">
+ <summary>A <see cref="T:System.Guid"/> uniquely identifying the provider used to create this shadow copy.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.SnapshotAttributes">
<summary>
- The system was unable to hold I/O writes. This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
+ The attributes of the shadow copy expressed as a bit mask (or bitwise OR) of members of
+ the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> enumeration.
</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssComponentType">
+ <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.CreationTimestamp">
+ <summary>Time stamp indicating when the shadow copy was created. The exact time is determined by the provider.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssSnapshotProperties.Status">
+ <summary>Current shadow copy creation status. See <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotState"/>.</summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssRevertInProgressException">
<summary>
- The <see cref="T:Alphaleonis.Win32.Vss.VssComponentType"/> enumeration is used by both the requester and the writer to specify the type of component being used
- with a shadow copy backup operation.
+ Exception thrown to indicate that the volume already has a revert in progress.
</summary>
<remarks>
- <para>
- A writer sets a component's type when it adds the component to its Writer Metadata Document using
- <c>IVssCreateWriterMetadata.AddComponent</c>
- </para>
- <para>
- Writers and requesters can find the type information of components selected for inclusion in a Backup
- Components Document through calls to <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.ComponentType"/> to return a component type directly.
- </para>
- <para>
- A requester can obtain the type of any component in a given writer's Writer Metadata Document by doing the following:
- <list type="number">
- <item><description>Using <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Components"/> to obtain a <see cref="T:Alphaleonis.Win32.Vss.IVssWMComponent"/> interface</description></item>
- <item><description>Examining the Type member of the <see cref="T:Alphaleonis.Win32.Vss.IVssWMComponent"/> object</description></item>
- </list>
- </para>
+ <note>
+ <b>Windows XP and Windows 2003:</b> This error is not supported until Windows Vista.
+ </note>
</remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssComponentType.Undefined">
- <summary><para>Undefined component type.</para>
- <para>This value indicates an application error.</para>
+ <member name="M:Alphaleonis.Win32.Vss.VssRevertInProgressException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRevertInProgressException"/>
+ class with a system-supplied message describing the error.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssComponentType.Database">
- <summary>Database component.</summary>
+ <member name="M:Alphaleonis.Win32.Vss.VssRevertInProgressException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRevertInProgressException"/> class with a specified error message.
+ </summary>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssComponentType.FileGroup">
- <summary>File group component. This is any component other than a database.</summary>
+ <member name="M:Alphaleonis.Win32.Vss.VssRevertInProgressException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRevertInProgressException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssComponentFlags">
+ <member name="M:Alphaleonis.Win32.Vss.VssRevertInProgressException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- The <see cref="T:Alphaleonis.Win32.Vss.VssComponentFlags"/> enumeration is used by writers to indicate support for auto-recovery.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssRevertInProgressException"/> class.
</summary>
- <remarks>For more information see <see href="http://msdn.microsoft.com/en-us/library/aa384681(VS.85).aspx">MSDN documentation on VSS_COMPONENT_FLAGS Enumeration</see></remarks>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssComponentFlags.None">
+ <member name="T:Alphaleonis.Win32.Vss.VssUsageType">
+ <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssUsageType"/> enumeration specifies how the host system uses the data managed by a writer involved in a VSS operation.</summary>
+ <remarks>Requester applications that are interested in backing up system state should look for writers with the
+ <see cref="F:Alphaleonis.Win32.Vss.VssUsageType.BootableSystemState"/> or <see cref="F:Alphaleonis.Win32.Vss.VssUsageType.SystemService"/> usage type.</remarks>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssUsageType.Undefined">
+ <summary><para>The usage type is not known.</para><para>This indicates an error on the part of the writer.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssUsageType.BootableSystemState">
+ <summary>The data stored by the writer is part of the bootable system state.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssUsageType.SystemService">
+ <summary>The writer either stores data used by a system service or is a system service itself.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssUsageType.UserData">
+ <summary>The data is user data.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssUsageType.Other">
+ <summary>Unclassified data.</summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssRestoreMethod">
+ <summary>This enumeration is used by a writer at backup time to specify through its Writer Metadata Document the default file restore
+ method to be used with all the files in all the components it manages.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.Undefined">
<summary>
- This value is reserved for operating systems that do not support the <see cref="T:Alphaleonis.Win32.Vss.VssComponentFlags"/> enumeration.
+ <para>No restore method is defined.</para>
+ <para>This indicates an error on the part of the writer.</para>
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssComponentFlags.BackupRecovery">
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreIfNotThere">
<summary>
+ A requester will restore files of a selected component or component set only if there are no versions of those files currently on the disk.
+ </summary>
+ <remarks>
+ <para>Unless alternate location mappings are defined for file restoration, if a version of any file managed by a selected component or component set is currently on the disk, none of the files managed by the selected component or component set will be restored.</para>
+ <para>If a file's alternate location mapping is defined, and a version of the files is present on disk at the original location, files will be written to the alternate location as long as no version of the file exists at the alternate location.</para>
+ </remarks>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreIfCanReplace">
+ <summary>
+ A requester will restore files of a selected component or component set only if there are no versions of those files currently on the disk that cannot be overwritten.
+ </summary>
+ <remarks>
+ <para>Unless alternate location mappings are defined for file restoration, if there is a version of any file that cannot be overwritten of the selected component or component set on the disk, none of the files managed by the component or component set will be restored.</para>
+ <para>If a file's alternate location mapping is defined, files will be written to the alternate location.</para>
+ </remarks>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.StopRestoreStart">
+ <summary>
+ This value is used by a writer to indicates that a given service must be stopped prior to the start of the restore. After the restore operation, the service will be restarted.
+ </summary>
+ <remarks>
+ The service to be stopped is specified by an argument to <c>IVssCreateWriterMetadata.SetRestoreMethod</c>.
+ </remarks>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreToAlternateLocation">
+ <summary>
+ A requester must restore the files of a selected component or component set to the location specified by the alternate location mapping specified in the writer component metadata file.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreAtReboot">
+ <summary>
+ A requester will restore the files of a selected component or component set following a reboot of the system.
<para>
- The writer will need write access to this component after the shadow copy has been created.
- </para>
- <para>
- This flag is incompatible with <see cref="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Transportable"/>.
+ Files to be restored should be copied to a temporary location, and the requester should use <c>File.Move</c> with the <c>DelayUntilReboot</c> flag
+ to complete the restoration of these files to their proper location following reboot. (Using AlphaFS for file operations).
</para>
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssComponentFlags.RollbackRecovery">
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreAtRebootIfCannotReplace">
<summary>
- <para>
- If this is a rollback shadow copy (<see cref="T:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes"/> enumeration value of
- <see cref="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.RollbackRecovery"/>), the writer for this component will need
- write access to this component after the shadow copy has been created.
- </para>
- <para>
- This flag is incompatible with <see cref="F:Alphaleonis.Win32.Vss.VssVolumeSnapshotAttributes.Transportable"/>.
- </para>
+ If possible, a requester will restore the files of a selected component or component set to their correct location immediately.
</summary>
+ <remarks>
+ <para>If there are versions of any of the files managed by the selected component or component set on the disk that cannot be overwritten, then all the files managed by the selected component or component set will be restored following the reboot of the system.</para>
+ <para>In this case, files to be restored should be copied to a temporary location, and the requester should use <c>File.Move</c> with the <c>DelayUntilReboot</c> flag
+ to complete the restoration of these files to their proper location following reboot. (Using AlphaFS for file operations). </para>
+ <note><b>Windows XP:</b> This value is not supported until Windows Server 2003</note>
+ </remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssComponentFlags.NotSystemState">
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.Custom">
<summary>
- <para>
- This component is not part of system state.
- </para>
- <para>
- <b>Windows Server 2003:</b> This value is not supported until Windows Vista.
- </para>
+ This value indicates that a custom restore method will be used to restore the files managed by the selected component or component set.
</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException">
+ <member name="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreStopStart">
<summary>
- Exception indicating that the resynchronization destination contained a volume that was not explicitly included.
+ The requester should perform the restore operation as follows:
+ <list type="number">
+ <item><description>Send the PreRestore event and wait for all writers to process it.</description></item>
+ <item><description>Restore the files to their original locations.</description></item>
+ <item><description>Send the PostRestore event and wait for all writers to process it.</description></item>
+ <item><description>Stop the service.</description></item>
+ <item><description>Restart the service.</description></item>
+ </list>
+ <para>The service to be stopped is specified by the writer beforehand when it calls the IVssCreateWriterMetadata::SetRestoreMethod method.
+ The requester can obtain the name of the service by examining the <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.RestoreMethod"/> property.</para>
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException.#ctor">
+ <member name="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException"/> class.
+ Exception thrown to indicate that the volume does not support the requested operation, or that no provider supports it.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException.#ctor(System.String)">
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException.#ctor">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/>
+ class with a system-supplied message describing the error.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException.#ctor(System.String,System.Exception)">
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException.#ctor(System.String,System.Exception)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssCannotRevertDiskIdException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="info"/> parameter is <see langword="null"/>.
- </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">
- The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
- </exception>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssWMDependency">
+ <member name="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException">
<summary>
- <see cref="T:Alphaleonis.Win32.Vss.VssWMDependency"/> is used to determine the writer ID, logical path, and component name of components that must be restored or
- backed up along with the target component.</summary>
- <remarks>Note that a dependency does not indicate an order of preference between the component with the documented dependencies and the components it depends on. A dependency merely indicates that the component and the components it depends on must always be backed up or restored together.
- <note><b>Windows XP:</b> This class is not supported until Windows Server 2003</note>
+ Exception thrown to indicate that the system was unable to thaw the
+ Distributed Transaction Coordinator (DTC) or the Kernel Transaction Manager (KTM).
+ </summary>
+ <remarks>
+ <note>
+ <b>Windows Server 2003 and Windows XP:</b> This exception is not supported until Windows Vista.
+ </note>
</remarks>
- <seealso href="http://msdn.microsoft.com/en-us/library/aa384301(VS.85).aspx"/>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssWMDependency.#ctor(System.Guid,System.String,System.String)">
+ <member name="M:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException.#ctor">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWMDependency"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException"/>
+ class with a system-supplied message describing the error.
</summary>
- <param name="writerId">The writer id.</param>
- <param name="logicalPath">The logical path.</param>
- <param name="componentName">Name of the component.</param>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssWMDependency.WriterId">
+ <member name="M:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException.#ctor(System.String)">
<summary>
- The class ID of a writer containing a component that the current component depends on.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException"/> class with a specified error message.
</summary>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssWMDependency.LogicalPath">
+ <member name="M:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException.#ctor(System.String,System.Exception)">
<summary>
- The logical path of a component that the current component depends on.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssWMDependency.ComponentName">
+ <member name="M:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- Retrieves the name of a component that the current component depends on.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTransactionThawTimeoutException"/> class.
</summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException">
+ <member name="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">
<summary>
- Exception thrown to indicate that the operation is not supported under the current context.
+ Exception thrown to indicate that the XML document is not valid. Check the event log for details.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnsupportedContextException.#ctor">
+ <member name="M:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException.#ctor">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException"/>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException"/>
class with a system-supplied message describing the error.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnsupportedContextException.#ctor(System.String)">
+ <member name="M:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException.#ctor(System.String)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException"/> class with a specified error message.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnsupportedContextException.#ctor(System.String,System.Exception)">
+ <member name="M:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException.#ctor(System.String,System.Exception)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException"/> class with
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException"/> class with
a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnsupportedContextException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="M:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnsupportedContextException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
<exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException">
+ <member name="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException">
<summary>
- Exception indicating that the resynchronization destination contained a volume that was not explicitly included.
+ Exception thrown to indicate that the system was unable to hold I/O writes.
</summary>
+ <remarks>
+ This can be a transient problem. It is recommended to wait ten minutes and try again, up to three times.
+ </remarks>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnselectedVolumeException.#ctor">
+ <member name="M:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException.#ctor">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException"/>
+ class with a system-supplied message describing the error.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnselectedVolumeException.#ctor(System.String)">
+ <member name="M:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException.#ctor(System.String)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException"/> class with a specified error message.
</summary>
<param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnselectedVolumeException.#ctor(System.String,System.Exception)">
+ <member name="M:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException.#ctor(System.String,System.Exception)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnselectedVolumeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="M:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnselectedVolumeException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssHoldWritesTimeoutException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException">
+ <summary>
+ Exception indicating that the writer operation failed because of a time-out between the Freeze and Thaw events. The recommended way to
+ handle this error code is to wait ten minutes and then repeat the operation, up to three times.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssTimeoutWriterException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException"/> class.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssTimeoutWriterException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException"/> class.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssTimeoutWriterException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException"/> class.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssTimeoutWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssTimeoutWriterException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
@@ -7542,6 +6805,543 @@ The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
</exception>
</member>
+ <member name="T:Alphaleonis.Win32.Vss.VssSnapshotState">
+ <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotState"/> enumeration is returned by a provider to specify the state of a given shadow copy operation.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Unknown">
+ <summary><para>Reserved for system use.</para><para>Unknown shadow copy state.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Preparing">
+ <summary><para>Reserved for system use.</para><para>Shadow copy is being prepared.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPrepare">
+ <summary><para>Reserved for system use.</para><para>Processing of the shadow copy preparation is in progress.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Prepared">
+ <summary><para>Reserved for system use.</para><para>Shadow copy has been prepared.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPreCommit">
+ <summary><para>Reserved for system use.</para><para>Processing of the shadow copy precommit is in process.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.PreComitted">
+ <summary><para>Reserved for system use.</para><para>Shadow copy is precommitted.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingCommit">
+ <summary><para>Reserved for system use.</para><para>Processing of the shadow copy commit is in process.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Committed">
+ <summary><para>Reserved for system use.</para><para>Shadow copy is committed.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPostCommit">
+ <summary><para>Reserved for system use.</para><para>Processing of the shadow copy postcommit is in process.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPreFinalCommit">
+ <summary><para>Reserved for system use.</para><para>Processing of the shadow copy file commit operation is underway.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.PreFinalCommitted">
+ <summary><para>Reserved for system use.</para><para>Processing of the shadow copy file commit operation is done.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.ProcessingPostFinalCommit">
+ <summary><para>Reserved for system use.</para><para>Processing of the shadow copy following the final commit and prior to shadow copy create is underway.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Created">
+ <summary><para>Shadow copy is created.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Aborted">
+ <summary><para>Reserved for system use.</para><para>Shadow copy creation is aborted.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.Deleted">
+ <summary><para>Reserved for system use.</para><para>Shadow copy has been deleted.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssSnapshotState.PostCommitted">
+ <summary><para>Reserved value.</para></summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException">
+ <summary>
+ Exception indicating that the maximum number of shadow copy storage areas has been added to
+ the shadow copy source volume. The specified shadow copy storage volume was not associated
+ with the specified shadow copy source volume.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException"/>
+ class with a system-supplied message describing the error.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException"/> class with a specified error message.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssMaximumDiffAreaAssociationsReachedException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">
+ <summary>
+ Exception indicating that the requested method is not supported on the current operating system, or the loaded
+ assembly is targeted for a different operating system than the one on which it is running.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> class.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> class.
+ </summary>
+ <param name="message">The message.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> class.
+ </summary>
+ <param name="message">The message.</param>
+ <param name="innerException">The inner exception.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.ProcessorArchitecture">
+ <summary>
+ Enumeration used by <see cref="T:Alphaleonis.Win32.Vss.OperatingSystemInfo"/> to indicate the current
+ processor architecture for which the operating system is targeted and running.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.ProcessorArchitecture.X86">
+ <summary>
+ The system is running a 32-bit version of Windows.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.ProcessorArchitecture.IA64">
+ <summary>
+ The system is running an Itanium processor.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.ProcessorArchitecture.X64">
+ <summary>
+ The system is running a 64-bit version of Windows.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.ProcessorArchitecture.Unknown">
+ <summary>
+ Unknown architecture.
+ </summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException">
+ <summary>
+ Exception thrown to indicate that the volume is not supported by the specified provider.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException"/>
+ class with a system-supplied message describing the error.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException"/> class with a specified error message.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedByProviderException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssPartialFileInfo">
+ <summary>
+ Representation of information on a partial file associated with a component.
+ </summary>
+ <remarks>See <see href="http://msdn.microsoft.com/en-us/library/aa383529(VS.85).aspx">MSDN documentation on IVssComponent::GetPartialFile Method</see> for more information.</remarks>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssPartialFileInfo.#ctor(System.String,System.String,System.String,System.String)">
+ <summary>Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFileInfo"/> class</summary>
+ <param name="path">The path of the partial file.</param>
+ <param name="fileName">The name of the partial file.</param>
+ <param name="range">Either a listing of file offsets and lengths that make up the partial file support range
+ (the sections of the file that were backed up), or the name of a file containing such a list.</param>
+ <param name="metadata">Any additional metadata required by a writer to validate a partial file restore operation. The information in this
+ metadata string will be opaque to requesters. May be <see langword="null"/></param>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.Path">
+ <summary>
+ <para>
+ The path of the partial file.
+ </para>
+ <para>
+ Users of this public need to check to determine whether this path ends with a backslash ("\").
+ </para>
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.FileName">
+ <summary>The name of the partial file.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.Range">
+ <summary>
+ Either a listing of file offsets and lengths that make up the partial file support range
+ (the sections of the file that were backed up), or the name of a file containing such a list.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.Metadata">
+ <summary>
+ <para>
+ Any additional metadata required by a writer to validate a partial file restore operation. The information in this
+ metadata string will be opaque to requesters.
+ </para>
+ <para>
+ Additional metadata is not required, so <see cref="P:Alphaleonis.Win32.Vss.VssPartialFileInfo.Metadata"/> may also be empty (zero length).
+ </para>
+ </summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssBackupSchema">
+ <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssBackupSchema"/> enumeration is used by a writer to indicate the types of backup operations it can participate in.
+ The supported kinds of backup are expressed as a bit mask (or bitwise OR) of <see cref="T:Alphaleonis.Win32.Vss.VssBackupSchema"/> values.</summary>
+ <remarks>
+ <para>
+ <note>
+ <b>Windows XP:</b> This enumeration is not available until Windows Server 2003 or later.
+ </note>
+ </para>
+ <para>
+ Writer set their backup schemas with calls to <c>IVssCreateWriterMetadata.SetBackupSchema"</c>.
+ </para>
+ <para>
+ Requesters use <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.BackupSchema"/> to determine the backup schema that a writer supports.
+ </para>
+ <para>
+ For a specific kind of backup operation to be supported, the writer must support the corresponding schema, and the
+ requester must set the corresponding backup type.
+ </para>
+ <para>
+ For example, to involve a writer in an incremental backup operation, the requester must set the backup type to
+ <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>, and the writer should have a backup schema that includes <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental"/>.
+ </para>
+ <para>
+ A writer that does not support the backup schema corresponding to a requester's backup type should treat the backup operation
+ that is being performed as if it were a default (full) backup. If the desired backup type is not supported by the writer's
+ backup schema, the requester can either perform a full backup for this writer or exclude the writer from the backup operation.
+ A requester can exclude a writer by selecting none of the writer's components, or by disabling the writer
+ (see <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DisableWriterClasses(System.Guid[])"/> or
+ <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.DisableWriterInstances(System.Guid[])"/>).
+ </para>
+ </remarks>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Undefined">
+ <summary>
+ The writer supports a simple full backup and restoration of entire files (as defined by a <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> value of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Full"/>).
+ This backup scheme can be used as the basis of an incremental or differential backup. This is the default value.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Differential">
+ <summary>
+ The writer supports differential backups (corresponding to the <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> value <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Differential"/>).
+ Files created or changed since the last full backup are saved. Files are not marked as having been backed up. This setting does not preclude mixing of incremental and differential backups.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental">
+ <summary>
+ The writer supports incremental backups (corresponding to the <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> value <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>). Files created or changed since the last full or incremental backup are saved. Files are marked as having been backed up. This setting does not preclude mixing of incremental and differential backups.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.ExclusiveIncrementalDifferential">
+ <summary>
+ The writer supports both differential and incremental backup schemas, but only exclusively: for example, you cannot follow a differential backup with an incremental one.
+ A writer cannot support this schema if it does not support both incremental and differential schemas (<see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Differential"/> | <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental"/>).
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Log">
+ <summary>
+ <para>The writer supports backups that involve only the log files it manages (corresponding to a <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> value of <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Log"/>). </para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Copy">
+ <summary>
+ Similar to the default backup schema (<see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Undefined"/>), the writer supports copy backup operations
+ (corresponding to <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Copy"/>) where file access information (such as information as to when a file was
+ last backed up) will not be updated either in the writer's own state information or in the file system information. This type of
+ backup cannot be used as the basis of an incremental or differential backup.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Timestamped">
+ <summary>
+ <para>
+ A writer supports using the VSS time-stamp mechanism when evaluating if a file should be included in
+ differential or incremental operations (corresponding to <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Differential"/> and
+ <see cref="F:Alphaleonis.Win32.Vss.VssBackupType.Incremental"/>, respectively) using the <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.PreviousBackupStamp"/>,
+ <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.BackupStamp"/> setters, and the <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetPreviousBackupStamp(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/> method.
+ </para>
+ <para>
+ A writer cannot support this schema if it does not support either differential or incremental backup schemas
+ (<see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Differential"/> or <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental"/>).
+ </para>
+
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.LastModify">
+ <summary>
+ <para>
+ When implementing incremental or differential backups with differenced files, a writer can provide last modification
+ time information for files (using <c>IVssComponent.AddDifferencedFileByLastModifyTime</c>).
+ A requester then can use <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.DifferencedFiles"/> to obtain candidate files and information
+ about their last modification data. The requester can use this information (along with any records about
+ previous backup operations it maintains) to decide if a file should be included in incremental and differential backups.
+ </para>
+ <para>
+ This scheme does not apply to partial file implementations of incremental and differential backup operations.
+ </para>
+ <para>
+ A writer cannot support this schema if it does not support either incremental or differential backup
+ schemas (<see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Differential"/> or <see cref="F:Alphaleonis.Win32.Vss.VssBackupSchema.Incremental"/>.
+ </para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.Lsn">
+ <summary>
+ Reserved for system use.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.WriterSupportsNewTarget">
+ <summary>
+ The writer supports a requester changing the target for file restoration using
+ <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.AddNewTarget(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String,System.String,System.Boolean,System.String)"/>.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.WriterSupportsRestoreWithMove">
+ <summary>
+ <para>
+ The writer supports running multiple writer instances with the same class ID, and it supports a
+ requester moving a component to a different writer instance at restore time using
+ <see cref="O:Alphaleonis.Win32.Vss.IVssBackupComponents.SetSelectedForRestore"/>.
+ </para>
+ <para>
+ <b>Windows Server 2003:</b> This value is not supported until Windows Server 2003 SP1.
+ </para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.IndependentSystemState">
+ <summary>
+ <para>
+ The writer supports backing up data that is part of the system state, but that can also
+ be backed up independently of the system state.
+ </para>
+ <para>
+ <b>Windows Server 2003:</b> This value is not supported until Windows Vista.
+ </para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.RollForwardRestore">
+ <summary>
+ <para>
+ The writer supports a requester setting a roll-forward restore point using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRollForward(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,Alphaleonis.Win32.Vss.VssRollForwardType,System.String)"/>.
+ </para>
+ <para>
+ <b>Windows Server 2003:</b> This value is not supported until Windows Vista.
+ </para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.RestoreRename">
+ <summary>
+ <para>
+ The writer supports a requester setting a restore name using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRestoreName(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.String)"/>.
+ </para>
+ <para>
+ <b>Windows Server 2003:</b> This value is not supported until Windows Vista.
+ </para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.AuthoritativeRestore">
+ <summary>
+ <para>
+ The writer supports a requester setting authoritative restore using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetAuthoritativeRestore(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,System.Boolean)"/>.
+ </para>
+ <para>
+ <b>Windows Server 2003:</b> This value is not supported until Windows Vista.
+ </para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssBackupSchema.WriterSupportsParallelRestores">
+ <summary>
+ <para>
+ The writer supports multiple unsynchronized restore events.
+ </para>
+ <para>
+ <b>Windows Vista and Windows Server 2003:</b> This value is not supported until Windows Server 2008.
+ </para>
+ </summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor">
+ <summary>
+ The <see cref="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor"/> class is 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).
+ </summary>
+ <remarks>
+ The following methods return a <see cref="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor"/> instance:
+ <list type="bullet">
+ <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssComponent.AlternateLocationMappings"/></description></item>
+ <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssComponent.NewTargets"/></description></item>
+ <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.ExcludeFiles"/></description></item>
+ <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.AlternateLocationMappings"/></description></item>
+ <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.Files"/></description></item>
+ <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.DatabaseFiles"/></description></item>
+ <item><description><see cref="P:Alphaleonis.Win32.Vss.IVssWMComponent.DatabaseLogFiles"/></description></item>
+ </list>
+ </remarks>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssWMFileDescriptor.#ctor(System.String,Alphaleonis.Win32.Vss.VssFileSpecificationBackupType,System.String,System.String,System.Boolean)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssWMFileDescriptor"/> class.
+ </summary>
+ <param name="alternateLocation">The alternate location.</param>
+ <param name="backupTypeMask">The backup type mask.</param>
+ <param name="fileSpecification">The file specification.</param>
+ <param name="path">The path.</param>
+ <param name="isRecursive">if set to <c>true</c> this file description is recursive.</param>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.AlternateLocation">
+ <summary>
+ Obtains the alternate backup location of the component files.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.BackupTypeMask">
+ <summary>
+ Obtains the file backup specification for a file or set of files.
+ </summary>
+ <remarks><note><b>Windows XP:</b> This value is not supported in Windows XP and will always return <see cref="F:Alphaleonis.Win32.Vss.VssFileSpecificationBackupType.Unknown"/></note></remarks>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.FileSpecification">
+ <summary>
+ Obtains the file specification for the list of files provided.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.Path">
+ <summary>
+ Obtains the fully qualified directory path for the list of files provided.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssWMFileDescriptor.IsRecursive">
+ <summary>
+ Determines whether only files in the root directory or files in the entire directory hierarchy are considered for backup.
+ </summary>
+ <remarks>VSS API reference: <c>IVssWMFiledesc::GetRecursive()</c></remarks>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssComponentFailure">
+ <summary>
+ Represents a component-level error reported by writers.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssComponentFailure.#ctor(System.Int32,System.Int32,System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssComponentFailure"/> class.
+ </summary>
+ <param name="errorCode">The error code.</param>
+ <param name="applicationErrorCode">The application error code.</param>
+ <param name="applicationMessage">The application message.</param>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssComponentFailure.ErrorCode">
+ <summary>
+ Gets the HRESULT failure code that the writer passed for the hr parameter of the IVssComponentEx2::SetFailure method.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssComponentFailure.ApplicationErrorCode">
+ <summary>
+ Gets the additional error code if provided by the writer.
+ </summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssComponentFailure.ApplicationMessage">
+ <summary>
+ Gets an error message for the requester to display to the end user. The writer is responsible for localizing this string if necessary before using it in this method. This parameter is optional and can be <see langword="null"/> or an empty string.
+ </summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssWriterState">
+ <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssWriterState"/> enumeration indicates the current state of the writer.</summary>
+ <remarks>A requester determines the state of a writer through <see cref="P:Alphaleonis.Win32.Vss.IVssBackupComponents.WriterStatus"/>.</remarks>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.Unknown">
+ <summary><para>The writer's state is not known.</para><para>This indicates an error on the part of the writer.</para></summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.Stable">
+ <summary>The writer has completed processing current shadow copy events and is ready to proceed, or <c>CVssWriter::OnPrepareSnapshot</c> has not yet been called.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.WaitingForFreeze">
+ <summary>The writer is waiting for the freeze state.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.WaitingForThaw">
+ <summary>The writer is waiting for the thaw state.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.WaitingForPostSnapshot">
+ <summary>The writer is waiting for the <c>PostSnapshot</c> state.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.WaitingForBackupComplete">
+ <summary>The writer is waiting for the requester to finish its backup operation.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtIdentify">
+ <summary>The writer vetoed the shadow copy creation process at the writer identification state.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPrepareBackup">
+ <summary>The writer vetoed the shadow copy creation process during the backup preparation state.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPrepareSnapshot">
+ <summary>The writer vetoed the shadow copy creation process during the <c>PrepareForSnapshot</c> state.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtFreeze">
+ <summary>The writer vetoed the shadow copy creation process during the freeze state.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtThaw">
+ <summary>The writer vetoed the shadow copy creation process during the thaw state.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPostSnapshot">
+ <summary>The writer vetoed the shadow copy creation process during the <c>PostSnapshot</c> state.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtBackupComplete">
+ <summary>The shadow copy has been created and the writer failed during the <c>BackupComplete</c> state.
+ A writer should save information about this failure to the error log.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPreRestore">
+ <summary>The writer failed during the <c>PreRestore</c> state.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtPostRestore">
+ <summary>The writer failed during the <c>PostRestore</c> state.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssWriterState.FailedAtBackupShutdown">
+ <summary>The writer failed during the shutdown of the backup application.</summary>
+ </member>
<member name="T:Alphaleonis.Win32.Vss.VssBackupType">
<summary>
The <see cref="T:Alphaleonis.Win32.Vss.VssBackupType"/> enumeration indicates the type of backup to be performed using VSS writer/requester
@@ -7623,235 +7423,360 @@ <member name="F:Alphaleonis.Win32.Vss.VssBackupType.Other">
<summary>Backup type that is not full, copy, log, incremental, or differential.</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssLegacyProviderException">
+ <member name="T:Alphaleonis.Win32.Vss.VssProviderProperties">
<summary>
- Exception indicating that this version of the hardware provider does not support this operation.
+ The <see cref="T:Alphaleonis.Win32.Vss.VssProviderProperties"/> class specifies shadow copy provider properties.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssLegacyProviderException.#ctor">
+ <member name="M:Alphaleonis.Win32.Vss.VssProviderProperties.#ctor(System.Guid,System.String,Alphaleonis.Win32.Vss.VssProviderType,System.String,System.Guid,System.Guid)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderProperties"/> class.
</summary>
+ <param name="providerId">The provider id.</param>
+ <param name="providerName">Name of the provider.</param>
+ <param name="providerType">Type of the provider.</param>
+ <param name="providerVersion">The provider version.</param>
+ <param name="providerVersionId">The provider version id.</param>
+ <param name="classId">The class id.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssLegacyProviderException.#ctor(System.String)">
+ <member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderId">
+ <summary>Identifies the provider who supports shadow copies of this class.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderName">
+ <summary>The provider name.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderType">
+ <summary>The provider type. See <see cref="T:Alphaleonis.Win32.Vss.VssProviderType"/> for more information.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderVersion">
+ <summary>The provider version in readable format.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ProviderVersionId">
+ <summary>A <see cref="T:System.Guid"/> uniquely identifying the version of a provider.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssProviderProperties.ClassId">
+ <summary>Class identifier of the component registered in the local machine's COM catalog.</summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException"/> class.
+ Contains information about a volume's shadow copy protection level.
</summary>
- <param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssLegacyProviderException.#ctor(System.String,System.Exception)">
+ <member name="M:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.#ctor(Alphaleonis.Win32.Vss.VssProtectionLevel,System.Boolean,Alphaleonis.Win32.Vss.VssProtectionFault,System.UInt32,System.Boolean)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo"/> class.
</summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
+ <param name="protectionLevel">The protection level.</param>
+ <param name="volumeIsOfflineForProtection">if set to <c>true</c> the volume is offline for protection.</param>
+ <param name="protectionFault">The protection fault.</param>
+ <param name="failureStatus">The failure status.</param>
+ <param name="volumeHasUnusedDiffArea">if set to <c>true</c> the volume has unused diff area.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssLegacyProviderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.ProtectionLevel">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssLegacyProviderException"/> class.
+ Gets the target protection level for the volume.
</summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">
- The <paramref name="info"/> parameter is <see langword="null"/>.
- </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">
- The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
- </exception>
+ <value>The target protection level for the volume.</value>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssDirectedTargetInfo">
+ <member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.VolumeIsOfflineForProtection">
<summary>
- Represents information stored by a writer, at backup time, to the Backup Components Document to indicate that when a
- file is to be restored, it (the source file) should be remapped. The file may be restored to a new restore target
- and/or ranges of its data restored to different locations with the restore target.
+ Gets a value indicating whether the volume is offline due to a protection fault.
</summary>
+ <value>
+ <c>true</c> if the volume is offline due to a protection fault; otherwise, <c>false</c>.
+ </value>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.#ctor(System.String,System.String,System.String,System.String,System.String,System.String)">
- <summary>Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDirectedTargetInfo"/> class.</summary>
- <param name="sourcePath">The source path.</param>
- <param name="sourceFileName">The source file name.</param>
- <param name="sourceRangeList">The source range list.</param>
- <param name="destinationPath">The destination path.</param>
- <param name="destinationFileName">The destination file name.</param>
- <param name="destinationRangeList">The destination range list.</param>
+ <member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.ProtectionFault">
+ <summary>
+ Gets a value that describes the shadow copy protection fault that caused the volume to go offline.
+ </summary>
+ <value>A value that describes the shadow copy protection fault that caused the volume to go offline.</value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.SourcePath">
+ <member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.FailureStatus">
<summary>
- The path to the directory that at backup time contained the file to be restored (the source file). This path should
- match or be beneath the path of a file set already in the component or one of its Subcomponents
- (if the component defines a component set).
+ Gets the internal failure status code.
</summary>
+ <value>The internal failure status code.</value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.SourceFileName">
+ <member name="P:Alphaleonis.Win32.Vss.VssVolumeProtectionInfo.VolumeHasUnusedDiffArea">
<summary>
- The name of the file (at backup time) that is to be remapped during a restore (the source file).
- The name of this file should not contain any wildcard characters, and must be a member of the same
- file set as the source path (<see cref="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.SourcePath"/>).
+ Gets a value indicating whether the volume has unused shadow copy storage area files or not.
</summary>
+ <value>
+ <c>true</c> if the volume has unused shadow copy storage area files; otherwise, <c>false</c>.
+ </value>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.SourceRangeList">
+ <member name="T:Alphaleonis.Win32.Vss.VssDifferencedFileInfo">
+ <summary>
+ Information about a file set (a specified file or files) to participate in an incremental or differential backup
+ or restore as a differenced file, that is, backup and restores associated with it are to be implemented as if
+ entire files are copied to and from backup media (as opposed to using partial files).
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.#ctor(System.String,System.String,System.Boolean,System.DateTime)">
+ <summary>Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDifferencedFileInfo"/> class.</summary>
+ <param name="path">The path to the differenced files.</param>
+ <param name="fileSpecification">The file specification of the differenced files.</param>
+ <param name="lastModifyTime">The time of last modification for the difference files.</param>
+ <param name="isRecursive"><see langword="true"/> if the filespec for the differenced files should be interpreted recursively, <see langword="false"/> otherwise.</param>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.Path">
<summary>
<para>
- A comma-separated list of file offsets and lengths indicating the source file
- support range (the sections of the file to be restored).
+ The path to the differenced files.
</para>
<para>
- The number and length of the source file support ranges must match the number and size of destination file support ranges.
+ Users of this method need to check to determine whether this path ends with a backslash (\).
</para>
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.DestinationPath">
+ <member name="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.FileSpecification">
+ <summary>The file specification of the differenced files.</summary>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.IsRecursive">
<summary>
- The path to which source file data will be remapped at restore time.
+ Boolean specifying whether the file specification for the differenced files should be interpreted recursively.
+ If <see langword="true"/>, then the entire directory hierarchy will need to be searched for files matching the
+ file specification <see cref="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.FileSpecification"/> to find files to be handled as differenced files during incremental
+ or differential backups. If <see langword="false"/>, only the root directory needs to be searched.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.DestinationFileName">
+ <member name="P:Alphaleonis.Win32.Vss.VssDifferencedFileInfo.LastModifyTime">
<summary>
- The name of the file to which source file data will be remapped at restore time.
+ The writer specification of the time of last modification for the difference files.
</summary>
</member>
- <member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.DestinationRangeList">
+ <member name="T:Alphaleonis.Win32.Vss.VssProviderVetoException">
<summary>
- <para>
- A comma-separated list of file offsets and lengths indicating the destination file support range (locations to which
- the sections of the source file are to be restored).
- </para>
- <para>
- The number and length of the destination file support ranges must match the number and size of source file support ranges.
- </para>
+ Exception thrown to indicate an expected provider error. The provider logged the error in the event log.
</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.IVssSnapshotManagement">
+ <member name="M:Alphaleonis.Win32.Vss.VssProviderVetoException.#ctor">
<summary>
- The <see cref="T:Alphaleonis.Win32.Vss.IVssSnapshotManagement"/> interface provides a method that returns an interface to further configure a shadow copy provider.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException"/>
+ class with a system-supplied message describing the error.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.IVssSnapshotManagement.GetDifferentialSoftwareSnapshotManagementInterface">
+ <member name="M:Alphaleonis.Win32.Vss.VssProviderVetoException.#ctor(System.String)">
<summary>
- Gets an instance of the differential software snapshot management interface to further configure the system provider.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException"/> class with a specified error message.
</summary>
- <remarks>
- <para>
- <note>
- <para>
- <b>Windows XP:</b> This method is not supported until Windows 2003.
- </para>
- </note>
- </para>
- </remarks>
- <returns>An instance of the differential software snapshot management interface to further configure the system provider.</returns>
+ <param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.IVssSnapshotManagement.GetMinDiffAreaSize">
+ <member name="M:Alphaleonis.Win32.Vss.VssProviderVetoException.#ctor(System.String,System.Exception)">
<summary>
- Returns the current minimum size of the shadow copy storage area.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException"/> class with
+ a specified error message and a reference to the inner exception that is the cause of this exception.
+ </summary>
+ <param name="message">The message that describes the error</param>
+ <param name="innerException">The exception that is the cause of the current exception.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssProviderVetoException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssProviderVetoException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssComponentType">
+ <summary>
+ The <see cref="T:Alphaleonis.Win32.Vss.VssComponentType"/> enumeration is used by both the requester and the writer to specify the type of component being used
+ with a shadow copy backup operation.
</summary>
<remarks>
<para>
- The shadow copy storage area minimum size is a per-computer setting. Prior to Windows Server 2003 Service Pack 1 (SP1), this
- was fixed at 100 MB. With Windows Server 2003 SP1, the shadow copy storage area has a minimum size of 300 MB and can be
- increased in 300 MB increments up to 3000 MB (3 GB). This setting is stored in the <c>MinDiffAreaFileSize</c> value of type
- <c>REG_DWORD</c> in <c>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\VolSnap</c> (the value is the size, in MB).
+ A writer sets a component's type when it adds the component to its Writer Metadata Document using
+ <c>IVssCreateWriterMetadata.AddComponent</c>
</para>
<para>
- <note>
- <para>
- <b>Windows XP and Windows 2003:</b> This method is not supported until Windows 2003 SP1.
- </para>
- </note>
+ Writers and requesters can find the type information of components selected for inclusion in a Backup
+ Components Document through calls to <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.ComponentType"/> to return a component type directly.
+ </para>
+ <para>
+ A requester can obtain the type of any component in a given writer's Writer Metadata Document by doing the following:
+ <list type="number">
+ <item><description>Using <see cref="P:Alphaleonis.Win32.Vss.IVssExamineWriterMetadata.Components"/> to obtain a <see cref="T:Alphaleonis.Win32.Vss.IVssWMComponent"/> interface</description></item>
+ <item><description>Examining the Type member of the <see cref="T:Alphaleonis.Win32.Vss.IVssWMComponent"/> object</description></item>
+ </list>
</para>
</remarks>
- <returns>The current minimum size of the shadow copy storage area.</returns>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException">
+ <member name="F:Alphaleonis.Win32.Vss.VssComponentType.Undefined">
+ <summary><para>Undefined component type.</para>
+ <para>This value indicates an application error.</para>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssComponentType.Database">
+ <summary>Database component.</summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssComponentType.FileGroup">
+ <summary>File group component. This is any component other than a database.</summary>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException">
<summary>
- Exception thrown to indicate that the XML document is not valid. Check the event log for details.
+ Exception thrown to indicate that the specified snapshot specifies a shadow copy that does not exist in the Backup Components Document.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException.#ctor">
+ <member name="M:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException.#ctor">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException"/>
- class with a system-supplied message describing the error.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException"/> class.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException.#ctor(System.String)">
+ <member name="M:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException.#ctor(System.String)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException"/> class with a specified error message.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException"/> class.
+ </summary>
+ <param name="message">The message.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException.#ctor(System.String,System.Exception)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException"/> class.
+ </summary>
+ <param name="message">The message.</param>
+ <param name="inner">The inner.</param>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssSnapshotNotInSetException"/> class.
+ </summary>
+ <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
+ <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
+ <exception cref="T:System.ArgumentNullException">
+ The <paramref name="info"/> parameter is <see langword="null"/>.
+ </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">
+ The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
+ </exception>
+ </member>
+ <member name="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException">
+ <summary>
+ Exception indicating the writer is reporting one or more component-level errors.
+ To retrieve the errors, the requester must use the <see cref="P:Alphaleonis.Win32.Vss.IVssComponent.Failure"/> property.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssPartialFailureWriterException.#ctor">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException"/> class.
+ </summary>
+ </member>
+ <member name="M:Alphaleonis.Win32.Vss.VssPartialFailureWriterException.#ctor(System.String)">
+ <summary>
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException.#ctor(System.String,System.Exception)">
+ <member name="M:Alphaleonis.Win32.Vss.VssPartialFailureWriterException.#ctor(System.String,System.Exception)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException"/> class.
</summary>
<param name="message">The message that describes the error</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="M:Alphaleonis.Win32.Vss.VssPartialFailureWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssInvalidXmlDocumentException"/> class.
+ Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssPartialFailureWriterException"/> class.
</summary>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ <exception cref="T:System.ArgumentNullException">
+ The <paramref name="info"/> parameter is <see langword="null"/>.
+ </exception>
+ <exception cref="T:System.Runtime.Serialization.SerializationException">
+ The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0).
+ </exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssWriterRestore">
- <summary>The <see cref="T:Alphaleonis.Win32.Vss.VssWriterRestore"/> enumeration is used by a writer to indicate to a requester the
- conditions under which it will handle events generated during a restore operation.</summary>
+ <member name="T:Alphaleonis.Win32.Vss.VssProtectionFault">
+ <summary>
+ Defines the set of shadow copy protection faults.
+ A shadow copy protection fault occurs when the VSS service is unable to perform a copy-on-
+ write operation to the shadow copy storage area (also called the diff area).
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterRestore.Undefined">
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.None">
<summary>
- <para>It is not known whether the writer will perform special operations during the restore operation.</para>
- <para>This state indicates a writer error.</para>
+ No shadow copy protection fault has occurred.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterRestore.Never">
- <summary>The writer does not require restore events.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.DiffAreaMissing">
+ <summary>
+ The volume that contains the shadow copy storage area could not be found. Usually this fault means that the volume has not yet arrived in the system.
+ </summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterRestore.IfReplaceFails">
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.IOFailureDuringOnline">
<summary>
- Indicates that the writer always expects to handle a <c>PreRestore</c> event, but expects to handle a
- <c>PostRestore</c> event only if a restore fails when implementing either a
- <see cref="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreIfNotThere"/> or
- <see cref="F:Alphaleonis.Win32.Vss.VssRestoreMethod.RestoreIfCanReplace"/> restore method (<see cref="T:Alphaleonis.Win32.Vss.VssRestoreMethod"/>)
+ The volume that contains the shadow copy storage area could not be brought online because an I/O failure occurred.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssWriterRestore.Always">
- <summary>The writer always performs special operations during the restore operation.</summary>
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.MetadataCorruption">
+ <summary>
+ The shadow copy metadata for the shadow copy storage area has been corrupted.
+ </summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssRollForwardType">
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.MemoryAllocationFailure">
<summary>
- The <c>VssRollForwardType</c> enumeration is used by a requester to indicate the type of roll-forward operation it is about to perform.
+ A memory allocation failure occurred. This could be caused by a temporary low-memory condition that does not happen again after you clear the fault and restart the shadow copy operation.
</summary>
- <remarks>
- A requester sets the roll-forward operation type and specifies the restore point for partial roll-forward operations
- using <see cref="M:Alphaleonis.Win32.Vss.IVssBackupComponents.SetRollForward(System.Guid,Alphaleonis.Win32.Vss.VssComponentType,System.String,System.String,Alphaleonis.Win32.Vss.VssRollForwardType,System.String)"/>.
- </remarks>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssRollForwardType.Undefined">
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.MappedMemoryFailure">
<summary>
- <para>
- No roll-forward type is defined.
- </para>
- <para>
- This indicates an error on the part of the requester.
- </para>
+ A memory mapping failure occurred. This fault could mean that the page file is too small, or it could be caused by a low-memory condition.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssRollForwardType.None">
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.CowReadFailure">
<summary>
- The roll-forward operation should not roll forward through logs.
+ A read failure occurred during the copy-on-write operation when data was being copied from the live volume to the shadow copy storage area volume.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssRollForwardType.All">
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.CowWriteFailure">
<summary>
- The roll-forward operation should roll forward through all logs.
+ A read or write failure occurred during the copy-on-write operation when data was being copied from the live volume to the shadow copy storage area volume. One possible reason is that the shadow copy storage area volume has been removed from the system.
</summary>
</member>
- <member name="F:Alphaleonis.Win32.Vss.VssRollForwardType.Partial">
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.DiffAreaFull">
<summary>
- The roll-forward operation should roll forward through logs up to a specified restore point.
+ This failure means that either the shadow copy storage area is full or the shadow copy storage area volume is full.
+ After clearing the protection fault, you can do one of the following:
+ <list type="bullet">
+ <item><description>Delete unused shadow copy storage areas by calling the <see cref="M:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.DeleteUnusedDiffAreas(System.String)"/> method.</description></item>
+ <item><description>Increase the shadow copy storage area maximum size for the volume by calling the <see cref="O:Alphaleonis.Win32.Vss.IVssDifferentialSoftwareSnapshotManagement.ChangeDiffAreaMaximumSize"/> method.</description></item>
+ </list>
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.GrowTooSlow">
+ <summary>
+ The size of the shadow copy storage area could not be increased because there was no longer enough space on the shadow copy storage area volume.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.GrowFailed">
+ <summary>
+ The size of the shadow copy storage area could not be increased.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.DestroyAllSnapshots">
+ <summary>
+ An unexpected error occurred.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.FileSystemFailure">
+ <summary>
+ Either the shadow copy storage area files could not be opened or the shadow copy storage area volume could not be mounted because of a file system operation failure.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.IOFailure">
+ <summary>
+ A read or write failure occurred on the shadow copy storage area volume.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.DiffAreaRemoved">
+ <summary>
+ The shadow copy storage area volume was removed from the system or could not be accessed for some other reason.
+ </summary>
+ </member>
+ <member name="F:Alphaleonis.Win32.Vss.VssProtectionFault.ExternalWriterToDiffArea">
+ <summary>
+ Another application attempted to write to the shadow copy storage area.
</summary>
</member>
<member name="T:Alphaleonis.Win32.Vss.OSVersionName">
@@ -7908,102 +7833,177 @@ A Windows version later than Windows Server 2008R2.
</summary>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException">
+ <member name="T:Alphaleonis.Win32.Vss.VssDirectedTargetInfo">
<summary>
- Exception thrown to indicate that the volume does not support the requested operation, or that no provider supports it.
+ Represents information stored by a writer, at backup time, to the Backup Components Document to indicate that when a
+ file is to be restored, it (the source file) should be remapped. The file may be restored to a new restore target
+ and/or ranges of its data restored to different locations with the restore target.
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException.#ctor">
+ <member name="M:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.#ctor(System.String,System.String,System.String,System.String,System.String,System.String)">
+ <summary>Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssDirectedTargetInfo"/> class.</summary>
+ <param name="sourcePath">The source path.</param>
+ <param name="sourceFileName">The source file name.</param>
+ <param name="sourceRangeList">The source range list.</param>
+ <param name="destinationPath">The destination path.</param>
+ <param name="destinationFileName">The destination file name.</param>
+ <param name="destinationRangeList">The destination range list.</param>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.SourcePath">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/>
- class with a system-supplied message describing the error.
+ The path to the directory that at backup time contained the file to be restored (the source file). This path should
+ match or be beneath the path of a file set already in the component or one of its Subcomponents
+ (if the component defines a component set).
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException.#ctor(System.String)">
+ <member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.SourceFileName">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> class with a specified error message.
+ The name of the file (at backup time) that is to be remapped during a restore (the source file).
+ The name of this file should not contain any wildcard characters, and must be a member of the same
+ file set as the source path (<see cref="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.SourcePath"/>).
</summary>
- <param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException.#ctor(System.String,System.Exception)">
+ <member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.SourceRangeList">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
+ <para>
+ A comma-separated list of file offsets and lengths indicating the source file
+ support range (the sections of the file to be restored).
+ </para>
+ <para>
+ The number and length of the source file support ranges must match the number and size of destination file support ranges.
+ </para>
</summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.DestinationPath">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssVolumeNotSupportedException"/> class.
+ The path to which source file data will be remapped at restore time.
</summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
</member>
- <member name="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException">
+ <member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.DestinationFileName">
<summary>
- Exception thrown to indicate that the provider returned an unexpected error code. This can be a transient problem.
+ The name of the file to which source file data will be remapped at restore time.
</summary>
- <remarks>
- It is recommended to wait ten minutes and try again, up to three times.
- </remarks>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException.#ctor">
+ <member name="P:Alphaleonis.Win32.Vss.VssDirectedTargetInfo.DestinationRangeList">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException"/>
- class with a system-supplied message describing the error.
+ <para>
+ A comma-separated list of file offsets and lengths indicating the destination file support range (locations to which
+ the sections of the source file are to be restored).
+ </para>
+ <para>
+ The number and length of the destination file support ranges must match the number and size of source file support ranges.
+ </para>
</summary>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException.#ctor(System.String)">
+ <member name="T:Alphaleonis.Win32.Vss.OperatingSystemInfo">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException"/> class with a specified error message.
+ Static class providing access to information about the operating system under which the
+ assembly is executing.
</summary>
- <param name="message">The message that describes the error</param>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException.#ctor(System.String,System.Exception)">
+ <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsWow64Process">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException"/> class with
- a specified error message and a reference to the inner exception that is the cause of this exception.
+ Determines whether the current process is running under WOW64.
</summary>
- <param name="message">The message that describes the error</param>
- <param name="innerException">The exception that is the cause of the current exception.</param>
+ <returns>
+ <c>true</c> if the current process is running under WOW64; otherwise, <c>false</c>.
+ </returns>
</member>
- <member name="M:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
+ <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsAtLeast(Alphaleonis.Win32.Vss.OSVersionName)">
<summary>
- Initializes a new instance of the <see cref="T:Alphaleonis.Win32.Vss.VssUnexpectedProviderErrorException"/> class.
+ Determines whether the operating system is of the specified version or later.
</summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is <see langword="null"/>. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is <see langword="null"/> or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
+ <param name="version">The lowest version for which to return <c>true</c>.</param>
+ <returns>
+ <c>true</c> if the operating system is of the specified <paramref name="version"/> or later; otherwise, <c>false</c>.
+ </returns>
</member>
- <member name="T:Alphaleonis.Win32.Vss.ProcessorArchitecture">
+ <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsAtLeast(Alphaleonis.Win32.Vss.OSVersionName,System.Int32)">
<summary>
- Enumeration used by <see cref="T:Alphaleonis.Win32.Vss.OperatingSystemInfo"/> to indicate the current
- processor architecture for which the operating system is targeted and running.
+ Determines whether operating system is of the specified version or later, allowing specification of
+ a minimum service pack that must be installed on the lowest version.
</summary>
+ <param name="version">The minimum required version.</param>
+ <param name="servicePackVersion">The major version of the service pack that must be installed on the
+ minimum required version to return <c>true</c>. This can be 0 to indicate that no service pack is required.</param>
+ <returns>
+ <c>true</c> if the operating system matches the specified <paramref name="version"/> with the specified service pack, or if the operating system is of a later version; otherwise, <c>false</c>.
+ </returns>
</member>
- <member name="F:Alphaleonis.Win32.Vss.ProcessorArchitecture.X86">
+ <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.RequireServerOrClientAtLeast(Alphaleonis.Win32.Vss.OSVersionName,System.Int32,Alphaleonis.Win32.Vss.OSVersionName,System.Int32)">
<summary>
- The system is running a 32-bit version of Windows.
+ Determines whether operating system is of the specified server version or later or if it is of the specified client
+ version or later and throws <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> otherwise.
</summary>
+ <param name="serverVersion">The minimum server version.</param>
+ <param name="serverServicePackVersion">The minimum server service pack version (applies only if the version exactly matches the specified server version).</param>
+ <param name="clientVersion">The minimum client version.</param>
+ <param name="clientServicePackVersion">The minimum client service pack version (applies only if the version exactly matches the specified client version).</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.ProcessorArchitecture.IA64">
+ <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.RequireServer(Alphaleonis.Win32.Vss.OSVersionName,System.Int32)">
<summary>
- The system is running an Itanium processor.
+ Determines whether the operating system is a server operating system of atleast the specified <paramref name="serverVersion"/> and
+ <paramref name="serverServicePackVersion"/> and throws an <see cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException"/> otherwise.
</summary>
+ <param name="serverVersion">The server version.</param>
+ <param name="serverServicePackVersion">The server service pack version.</param>
</member>
- <member name="F:Alphaleonis.Win32.Vss.ProcessorArchitecture.X64">
+ <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.RequireAtLeast(Alphaleonis.Win32.Vss.OSVersionName)">
<summary>
- The system is running a 64-bit version of Windows.
+ Determines whether the assembly is executing on the specified operating system version or later.
+ If not, an exception is thrown.
</summary>
+ <param name="osVersion">The minimum operating system version required.</param>
+ <exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The current operating system is of a version earlier than the specified <paramref name="osVersion"/></exception>
</member>
- <member name="F:Alphaleonis.Win32.Vss.ProcessorArchitecture.Unknown">
+ <member name="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.RequireAtLeast(Alphaleonis.Win32.Vss.OSVersionName,System.Int32)">
<summary>
- Unknown architecture.
+ Determines whether the assembly is executing on the specified operating system version with
+ the specified service pack installed or any later version of windows. If not, an exception is thrown.
+ </summary>
+ <param name="osVersion">The minimum operating system version required.</param>
+ <param name="servicePackVersion">The minimum service pack version required.</param>
+ <exception cref="T:Alphaleonis.Win32.Vss.UnsupportedOperatingSystemException">The current operating system is of a version earlier
+ than the specified <paramref name="osVersion"/> or the versions match but the operating system does not
+ have at least the specified service pack version <paramref name="servicePackVersion"/> installed.</exception>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.OSVersionName">
+ <summary>
+ Gets the named version of the operating system.
+ </summary>
+ <value>The named version of the operating system.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsServer">
+ <summary>
+ Gets a value indicating whether the operating system is a server os.
+ </summary>
+ <value>
+ <c>true</c> if the current operating system is a server os; otherwise, <c>false</c>.
+ </value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.OSVersion">
+ <summary>
+ Gets the numeric version of the operating system. This is the same as returned by
+ <see cref="P:System.Environment.OSVersion"/>.
+ </summary>
+ <value>The numeric version of the operating system.</value>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.ServicePackVersion">
+ <summary>
+ Gets the version of the service pack currently installed on the operating system.
+ </summary>
+ <value>The version of the service pack currently installed on the operating system.</value>
+ <remarks>Only the <see cref="P:System.Version.Major"/> and <see cref="P:System.Version.Minor"/> fields are
+ used.</remarks>
+ </member>
+ <member name="P:Alphaleonis.Win32.Vss.OperatingSystemInfo.ProcessorArchitecture">
+ <summary>
+ Gets the processor architecture for which the operating system is targeted.
</summary>
+ <value>The processor architecture for which the operating system is targeted.</value>
+ <remarks>If running under WOW64 this will return a 32-bit processor. Use <see cref="M:Alphaleonis.Win32.Vss.OperatingSystemInfo.IsWow64Process"/> to
+ determine if this is the case.
+ </remarks>
</member>
</members>
</doc>
diff --git a/thirdparty/alphavss/platform/AlphaVSS.51.x86.dll b/thirdparty/alphavss/platform/AlphaVSS.51.x86.dll Binary files differindex aeee69c78..bb41a02d7 100755 --- a/thirdparty/alphavss/platform/AlphaVSS.51.x86.dll +++ b/thirdparty/alphavss/platform/AlphaVSS.51.x86.dll diff --git a/thirdparty/alphavss/platform/AlphaVSS.52.x64.dll b/thirdparty/alphavss/platform/AlphaVSS.52.x64.dll Binary files differindex bea440ff7..00c4408ec 100755 --- a/thirdparty/alphavss/platform/AlphaVSS.52.x64.dll +++ b/thirdparty/alphavss/platform/AlphaVSS.52.x64.dll diff --git a/thirdparty/alphavss/platform/AlphaVSS.52.x86.dll b/thirdparty/alphavss/platform/AlphaVSS.52.x86.dll Binary files differindex bf1dd2328..d4157be31 100755 --- a/thirdparty/alphavss/platform/AlphaVSS.52.x86.dll +++ b/thirdparty/alphavss/platform/AlphaVSS.52.x86.dll diff --git a/thirdparty/alphavss/platform/AlphaVSS.60.x64.dll b/thirdparty/alphavss/platform/AlphaVSS.60.x64.dll Binary files differindex 93f6f8725..50b0fcdd4 100755 --- a/thirdparty/alphavss/platform/AlphaVSS.60.x64.dll +++ b/thirdparty/alphavss/platform/AlphaVSS.60.x64.dll diff --git a/thirdparty/alphavss/platform/AlphaVSS.60.x86.dll b/thirdparty/alphavss/platform/AlphaVSS.60.x86.dll Binary files differindex 92aedb951..08794366d 100755 --- a/thirdparty/alphavss/platform/AlphaVSS.60.x86.dll +++ b/thirdparty/alphavss/platform/AlphaVSS.60.x86.dll |