IPageDescendantsIDsWithMaxDepth Method Ingeniux CMS Content Store API

Retrieves metadata of the descendants of this page within the given depth limit.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)
Syntax

IEnumerable<PageHierarchyAndID> DescendantsIDsWithMaxDepth(
	out int count,
	int maxDepth,
	int maxCount = -1
)

Parameters

count
Type: SystemInt32
Total count of all descendant pages within the given depth limit..
maxDepth
Type: SystemInt32
The depth limit of descendants, relative of this page's hierarchy level.
Examples

A maxDepth value of 2 means to retrieve the descendants that are within 2 levels below the given page.
Remarks

A maxDepth of 0 means to retrieve all descendants.
maxCount (Optional)
Type: SystemInt32

[Missing <param name="maxCount"/> documentation for "M:Ingeniux.CMS.IPage.DescendantsIDsWithMaxDepth(System.Int32@,System.Int32,System.Int32)"]

Return Value

Type: IEnumerablePageHierarchyAndID
Collection of metadata of descendant pages within the depth limit
See Also

Reference