AFElement.LoadElementsToDepth Method

public static AFNamedCollectionList<AFElement> LoadElementsToDepth(
	IList<AFElement> elements,
	bool fullLoad,
	int depth,
	int maxCount
)

Public Shared Function LoadElementsToDepth ( 
	elements As IList(Of AFElement),
	fullLoad As Boolean,
	depth As Integer,
	maxCount As Integer
) As AFNamedCollectionList(Of AFElement)

Dim elements As IList(Of AFElement)
Dim fullLoad As Boolean
Dim depth As Integer
Dim maxCount As Integer
Dim returnValue As AFNamedCollectionList(Of AFElement)

returnValue = AFElement.LoadElementsToDepth(elements, 
	fullLoad, depth, maxCount)

public:
static AFNamedCollectionList<AFElement^>^ LoadElementsToDepth(
	IList<AFElement^>^ elements, 
	bool fullLoad, 
	int depth, 
	int maxCount
)

static member LoadElementsToDepth : 
        elements : IList<AFElement> * 
        fullLoad : bool * 
        depth : int * 
        maxCount : int -> AFNamedCollectionList<AFElement> 

Parameters

elements

Type: System.Collections.GenericIListAFElement
The list of root elements to be loaded. If , then this method does nothing. All elements in the list must be from the same PISystem and have the same QueryDate.

fullLoad

Type: SystemBoolean
Specifies whether the elements should be fully loaded. To only load a specific set of AFAttributes of the elements, specify and then use the LoadAttributes method to load those particular attributes. Note that if the elements are not fully loaded, then traversing the hierarchy via the Elements property will cause a reload of the element on access.

depth

Type: SystemInt32
Specifies the number of levels of the element hierarchy to load past the level of the elements in the collection passed in. For example, a depth parameter of 2 would indicate that all child elements and grandchild elements of the specified elements would be loaded.

maxCount

Type: SystemInt32
Specifies the maximum number of objects to load. Once the maximum number of objects is reached, the load will terminate.

Return Value

AFSDK

Reference