Click or drag to resize
IVssBackupComponentsSetBackupSucceeded Method
Indicates whether the backup of the specified component of a specific writer was successful.

Namespace: Alphaleonis.Win32.Vss
Assembly: AlphaVSS.Common (in AlphaVSS.Common.dll) Version: 1.3.0.0 (1.3.0.0)
Syntax
void SetBackupSucceeded(
	Guid instanceId,
	Guid writerId,
	VssComponentType componentType,
	string logicalPath,
	string componentName,
	bool succeeded
)

Parameters

instanceId
Type: SystemGuid
Globally unique identifier of the writer instance.
writerId
Type: SystemGuid
Globally unique identifier of the writer class.
componentType
Type: Alphaleonis.Win32.VssVssComponentType
Type of the component.
logicalPath
Type: SystemString

The logical path of the component to be added. For more information, see Logical Pathing of Components.

The value of the string containing the logical path used here should be the same as was used when the component was added to the backup set using AddComponent(Guid, Guid, VssComponentType, String, String).

The logical path can be .

There are no restrictions on the characters that can appear in a non-null logical path.

componentName
Type: SystemString

The name of the component.

The value of the string should not be , and should contain the same component as was used when the component was added to the backup set using AddComponent(Guid, Guid, VssComponentType, String, String).

succeeded
Type: SystemBoolean
The value of this parameter is if the component was successfully backed up, and if it was not.
Exceptions
ExceptionCondition
ArgumentNullExceptionOne of the arguments that cannot be was
ArgumentExceptionOne of the parameter values is not valid.
OutOfMemoryExceptionOut of memory or other system resources.
SystemExceptionUnexpected VSS system error. The error code is logged in the event log.
VssBadStateExceptionThe 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.
VssObjectNotFoundExceptionThe backup component does not exist.
VssInvalidXmlDocumentExceptionThe XML document is not valid. Check the event log for details.
Remarks

When working in component mode (when SetBackupState(Boolean, Boolean, VssBackupType, Boolean) is called with its select components argument set to ), writers the state of each components backup using BackupSucceeded.

Therefore, a well-behaved backup application (requester) must call SetBackupSucceeded(Guid, Guid, VssComponentType, String, String, Boolean) after each component has been processed and prior to calling BackupComplete.

See Also