IBackupRestoreTreeFormatter.PostObject method
Formats a string that will appear after the name of the component at the current node.
Namespace: Microsoft.SharePoint.Administration.Backup
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Syntax
'Declaration
Function PostObject ( _
obj As SPBackupRestoreObject, _
depth As Integer _
) As String
'Usage
Dim instance As IBackupRestoreTreeFormatter
Dim obj As SPBackupRestoreObject
Dim depth As Integer
Dim returnValue As String
returnValue = instance.PostObject(obj, _
depth)
string PostObject(
SPBackupRestoreObject obj,
int depth
)
Parameters
obj
Type: Microsoft.SharePoint.Administration.Backup.SPBackupRestoreObjectThe component for the current node.
depth
Type: System.Int32The depth in the tree of the current node.
Return value
Type: System.String
A String that will appear in the tree after each component name.
Remarks
Typically, an implementation of PostObject will return a String that ends with a new line character. Often, that is all it returns.
Examples
The following is a typical implementation of PostObject.
public String PostObject(SPBackupRestoreObject obj, int depth)
{
return Environment.NewLine;
}
Public Function PostObject(ByVal obj As SPBackupRestoreObject, ByVal depth As Integer) As String
Return Environment.NewLine
End Function
See also
Reference
IBackupRestoreTreeFormatter interface