Class VssWriterStatusInfo

Represenation of the status for a specific writer.

Inheritance

Object

VssWriterStatusInfo

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Alphaleonis.Win32.Vss

Assembly: AlphaVSS.Common.dll

Syntax

[Serializable]
public class VssWriterStatusInfo

Remarks

This class acts as a container for the information returned from IVssBackupComponents.GetWriterStatus in the original VSS API

Constructors

VssWriterStatusInfo(Guid, Guid, String, VssWriterState, VssError)

Initializes a new instance of the VssWriterStatusInfo class.

Declaration

public VssWriterStatusInfo(Guid instanceId, Guid writerId, string writerName, VssWriterState state, VssError failure)

Parameters

Type	Name	Description
Guid	instanceId	The writer instance id.
Guid	writerId	The writer class id.
String	writerName	Name of the writer.
VssWriterState	state	The state.
VssError	failure	The failure.

VssWriterStatusInfo(Guid, Guid, String, VssWriterState, VssError, Nullable<Int32>, String)

Initializes a new instance of the VssWriterStatusInfo class.

Declaration

public VssWriterStatusInfo(Guid instanceId, Guid writerClassId, string writerName, VssWriterState state, VssError failure, int? applicationErrorCode, string applicationErrorMessage)

Parameters

Type	Name	Description
Guid	instanceId	The writer instance id.
Guid	writerClassId	The writer class id.
String	writerName	Name of the writer.
VssWriterState	state	The state.
VssError	failure	The failure.
Nullable<Int32>	applicationErrorCode	The application error code.
String	applicationErrorMessage	The application error message.

Properties

ApplicationErrorCode

Gets the return code that the writer passed for the hrApplication parameter of the CVssWriterEx2::SetWriterFailureEx method.

Declaration

public int? ApplicationErrorCode { get; }

Property Value

Type	Description
Nullable<Int32>

Remarks

note

This property requires Windows 7 or Windows Server 2008 R2 and will be null on earlier operating systems.

ApplicationErrorMessage

Gets the application failure message that the writer passed for the wszApplicationMessage parameter of the SetWriterFailureEx method.

Declaration

public string ApplicationErrorMessage { get; }

Property Value

Type	Description
String

Remarks

note

This property requires Windows 7 or Windows Server 2008 R2 and will be null on earlier operating systems.

ClassId

The identifier of the writer class.

Declaration

public Guid ClassId { get; }

Property Value

Type	Description
Guid

Failure

A VssError value indicating the failure code (if any) of the writer.

Declaration

public VssError Failure { get; }

Property Value

Type	Description
VssError

Remarks

The following are the supported values for Failure:

Value	Meaning
Success	The writer was successful.
WriterErrorInconsistentSnapshot	The shadow copy contains only a subset of the volumes needed by the writer to correctly back up the application component.
WriterOutOfResources	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.
WriterTimeout	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.
WriterErrorRetryable	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.
WriterErrorNonRetryable	The writer operation failed because of an error that might recur if another shadow copy is created.
WriterNotResponding	The writer is not responding.
WriterStatusNotAvailable	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. Windows Vista, Windows Server 2003 and Windows XP: This value is not supported.

InstanceId

The instance id of the writer.

Declaration

public Guid InstanceId { get; }

Property Value

Type	Description
Guid

Name

The name of the writer.

Declaration

public string Name { get; }

Property Value

Type	Description
String

State

A VssWriterState value containing the state of the writer.

Declaration

public VssWriterState State { get; }

Property Value

Type	Description
VssWriterState