IBackupRestoreTreeFormatter.PostChildren method

Formats a string that will mark the end of a list of child nodes.

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

Syntax

'Declaration
Function PostChildren ( _
    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.PostChildren(obj, _
    depth)
string PostChildren(
    SPBackupRestoreObject obj,
    int depth
)

Parameters

  • depth
    Type: System.Int32

    The depth in the tree of the current node.

Return value

Type: System.String
A String that represents the end of a list of peer nodes that are each immediate children of obj.

Remarks

Typically, an implementation of this method returns an empty string. In most cases, the PostObject method will return a new line character. Since each child is an object, there is usually no need to return another new line character with PostChildren.

If your implementation does return a non-empty String, consider using depth as the measure of how far to indent the String.

Examples

The following code shows a typical implementation of PostChildren.

public String PostChildren(SPBackupRestoreObject obj, int depth)
{
    return String.Empty;
}
Public Function PostChildren(ByVal obj As SPBackupRestoreObject, ByVal depth As Integer) As String
    Return String.Empty
End Function

See also

Reference

IBackupRestoreTreeFormatter interface

IBackupRestoreTreeFormatter members

Microsoft.SharePoint.Administration.Backup namespace