Share via


SPBackupRestoreConsole.DiskSizeRequired method (Guid)

Gets the amount of disk space needed to backup the entire tree of components in the specified backup operation.

Namespace:  Microsoft.SharePoint.Administration.Backup
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public Shared Function DiskSizeRequired ( _
    id As Guid _
) As ULong
'Usage
Dim id As Guid
Dim returnValue As ULong

returnValue = SPBackupRestoreConsole.DiskSizeRequired(id)
public static ulong DiskSizeRequired(
    Guid id
)

Parameters

Return value

Type: System.UInt64
A UInt64 that represents the space, in bytes, needed on the backup device to store the backed up data.

Remarks

The DiskSizeRequired method sums the DiskSizeRequired values of all the objects included in the backup operation. It also adds 1K bytes to ensure that it always returns a minimum of 1K.

If MaxValue() is returned, then id does not identify a valid backup object.

See also

Reference

SPBackupRestoreConsole class

SPBackupRestoreConsole members

DiskSizeRequired overload

Microsoft.SharePoint.Administration.Backup namespace