Click or drag to resize

IVssBackupComponentsSetBackupState Method

Defines an overall configuration for a backup operation.

Namespace:  Alphaleonis.Win32.Vss
Assembly:  AlphaVSS.Common (in AlphaVSS.Common.dll) Version: 1.4.0.0 (1.4.0.0)
Syntax
void SetBackupState(
	bool selectComponents,
	bool backupBootableSystemState,
	VssBackupType backupType,
	bool partialFileSupport
)

Parameters

selectComponents
Type: SystemBoolean

Indicates whether a backup or restore operation will be in component mode.

Operation in component mode supports selectively backing up designated individual components (which can allow their exclusion), or only supports backing up all files and components on a volume.

The Boolean is if the operation will be conducted in component mode and if not.

backupBootableSystemState
Type: SystemBoolean

Indicates whether a bootable system state backup is being performed.

backupType
Type: Alphaleonis.Win32.VssVssBackupType

A VssBackupType enumeration value indicating the type of backup to be performed.

partialFileSupport
Type: SystemBoolean

If the value of this parameter is , partial file support is enabled. The default value for this argument is .

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.
VssInvalidXmlDocumentExceptionThe XML document is not valid. Check the event log for details.
Remarks
Applications must call SetBackupState(Boolean, Boolean, VssBackupType, Boolean) prior to calling PrepareForBackup.
See Also