Share via


SPIncludeDescendants Enumeration

Specifies the scope of descendants that are exported to the content migration package (.cmp) file, or that no descendants are exported.

Namespace:  Microsoft.SharePoint.Deployment
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

Public Enumeration SPIncludeDescendants

Dim instance As SPIncludeDescendants
public enum SPIncludeDescendants

Members

Member name Description
None Specifies that no descendants of the parent object are exported.
Content Specifies that only the direct descendants of the parent object are exported.
All Specifies that all descendants of the parent object, including nested generations, are exported.

Remarks

Use Content when you want to export only the immediate children of an object. Use All when you want to export all descendants.

When using these values, the type of the parent object affects what gets exported. For example, if the parent object is of type SPWeb, setting Content results in all objects within the Web being exported; however, subwebs are not exported. Setting All on a type SPWeb parent, though, causes all objects in the site scope to be exported, including subwebs and their descendants.

If the parent object is of type SPFolder, using Content exports only the files contained in the parent folder; using All causes both the files and all subfolders to be exported.

See Also

Reference

Microsoft.SharePoint.Deployment Namespace

Microsoft.SharePoint.SPWeb

SPFolder