SPBackupRestoreConsole.FormatTree method

Gets a tree view of the hierarchy of SharePoint Foundation components in the backup or restore operation down to the level of the content databases.

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

Syntax

'Declaration
Public Shared Function FormatTree ( _
    id As Guid, _
    format As IBackupRestoreTreeFormatter _
) As StringBuilder
'Usage
Dim id As Guid
Dim format As IBackupRestoreTreeFormatter
Dim returnValue As StringBuilder

returnValue = SPBackupRestoreConsole.FormatTree(id, _
    format)

public static StringBuilder FormatTree(
    Guid id,
    IBackupRestoreTreeFormatter format
)

Parameters

• id
  Type: System.Guid

  The Guid ID of the SPBackupRestoreConsoleObject that represents the backup or restore operation.

• format
  Type: Microsoft.SharePoint.Administration.Backup.IBackupRestoreTreeFormatter

  An object that defines the format of the tree.

Return value

Type: System.Text.StringBuilder
A StringBuilder that represents a tree view of components.

See also

Reference

SPBackupRestoreConsole class

SPBackupRestoreConsole members

Microsoft.SharePoint.Administration.Backup namespace