SPBackupRestoreObject.ToString Method

Returns the fully qualified name of the component represented by the IBackupRestore property.

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

Syntax

'Declaration
<SharePointPermissionAttribute(SecurityAction.Demand, ObjectModel := True)> _
Public Overrides Function ToString As String
'Usage
Dim instance As SPBackupRestoreObject
Dim returnValue As String

returnValue = instance.ToString()
[SharePointPermissionAttribute(SecurityAction.Demand, ObjectModel = true)]
public override string ToString()

Return Value

Type: System.String
A String that represents the full name of the component up to and including the name of the farm.

Remarks

In SharePoint Foundation, the string returned will have the following pattern:

Farm[\grandparent[\parent[\self]]]

For example, the following is the name of the first content database in a fresh installation of SharePoint Foundation.

Farm\SharePoint Web Application\SharePoint - 80\SPF_Content

If the component is the entire Web application, including all its content databases, then the string returned will have only three sections, for example:

Farm\SharePoint Web Application\SharePoint - 80

If the component is an entire Web service, then there will be only two parts to the string returned, for example:

Farm\SharePoint Search

Finally, "Farm" is returned if the component is the entire farm.

See Also

Reference

SPBackupRestoreObject Class

SPBackupRestoreObject Members

Microsoft.SharePoint.Administration.Backup Namespace