AFElement.GetParents Method (AFCategory, AFSortField, AFSortOrder, Int32)

Save PDF

Feedback

HomeAF SDK Reference...NamespacesOSIsoft.AF.AssetAFElement ClassAFElement MethodsGetParents Method AFElement.GetParents Method (AFCategory, AFSortField, AFSortOrder, Int32)

TABLE OF CONTENTS

AFElement.GetParents Method (AFCategory, AFSortField, AFSortOrder, Int32)

Save PDF

Feedback

Last UpdatedSep 18, 2024

Retrieves a non-paged collection of AFElement objects that reference this element using the specified AFCategory.

Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.0.1156

Syntax

public AFNamedCollectionList<AFElement> GetParents(
	AFCategory category,
	AFSortField sortField,
	AFSortOrder sortOrder,
	int maxCount
)

Public Function GetParents ( 
	category As AFCategory,
	sortField As AFSortField,
	sortOrder As AFSortOrder,
	maxCount As Integer
) As AFNamedCollectionList(Of AFElement)

Dim instance As AFElement
Dim category As AFCategory
Dim sortField As AFSortField
Dim sortOrder As AFSortOrder
Dim maxCount As Integer
Dim returnValue As AFNamedCollectionList(Of AFElement)

returnValue = instance.GetParents(category, 
	sortField, sortOrder, maxCount)

public:
AFNamedCollectionList<AFElement^>^ GetParents(
	AFCategory^ category, 
	AFSortField sortField, 
	AFSortOrder sortOrder, 
	int maxCount
)

member GetParents : 
        category : AFCategory * 
        sortField : AFSortField * 
        sortOrder : AFSortOrder * 
        maxCount : int -> AFNamedCollectionList<AFElement>

Parameters

category: Type: OSIsoft.AF.AFCategory
The AFCategory that an AFElement must have defined to be included in the returned list.
sortField: Type: OSIsoft.AF.AFSortField
The field or property of the object used to sort the returned collection.
sortOrder: Type: OSIsoft.AF.AFSortOrder
The order that the returned collection is sorted.
maxCount: Type: System.Int32
The maximum number of objects to be returned.

Return Value

Type: AFNamedCollectionList<AFElement>
Returns a collection containing the first page of AFElement objects which reference this element using the specified AFCategory.

Remarks

If a QueryDate is defined for the current element, then that query date will be used to determine the collection of elements that are returned from this method.

AF SDK Reference

Filters

Product Family