AFVersion.GetChildren Method

public IList GetChildren(
	AFSortField sortField,
	AFSortOrder sortOrder,
	int startIndex,
	int maxCount,
	out int totalCount
)

Public Function GetChildren ( 
	sortField As AFSortField,
	sortOrder As AFSortOrder,
	startIndex As Integer,
	maxCount As Integer,
	<OutAttribute> ByRef totalCount As Integer
) As IList

Dim instance As AFVersion
Dim sortField As AFSortField
Dim sortOrder As AFSortOrder
Dim startIndex As Integer
Dim maxCount As Integer
Dim totalCount As Integer
Dim returnValue As IList

returnValue = instance.GetChildren(sortField, 
	sortOrder, startIndex, maxCount, 
	totalCount)

public:
IList^ GetChildren(
	AFSortField sortField, 
	AFSortOrder sortOrder, 
	int startIndex, 
	int maxCount, 
	[OutAttribute] int% totalCount
)

member GetChildren : 
        sortField : AFSortField * 
        sortOrder : AFSortOrder * 
        startIndex : int * 
        maxCount : int * 
        totalCount : int byref -> IList 

Parameters

sortField

Type: OSIsoft.AFAFSortField
The field or property of the object used to sort the returned collection. This value should not be changed between calls when attempting to get the next page of items.

sortOrder

Type: OSIsoft.AFAFSortOrder
The order that the returned collection is sorted. This value should not be changed between calls when attempting to get the next page of items.

startIndex

Type: SystemInt32
The starting index (zero based) of the items to be returned.

maxCount

Type: SystemInt32
The maximum number of objects to be returned per call (the page size).

totalCount

Type: SystemInt32
The total number of objects that match the search criteria.

Return Value

This list is different than the collection of objects returned by setting the QueryDate of the owning object and asking for its sub-collection. That collection depends upon the QueryDate of the owning object.

This list will contain all of the objects which are owned by the specific version of the owning object without using a QueryDate. It will not return child objects which are only owned by a different version of the owning object.

Caution
Each call to this method will make a call to the server to load the list of children. The list is not cached by the SDK.

AFSDK

Reference