AFAnalysis.FindAnalysesByTemplate Method (AFDatabase, AFAnalysisTemplate, AFSortField, AFSortOrder, Int32, Int32, Int32)

[BrowsableAttribute(false)]
[ObsoleteAttribute("This method has been replaced by the 'AFAnalysisSearch' class using the 'Template' filter.")]
public static AFNamedCollectionList<AFAnalysis> FindAnalysesByTemplate(
	AFDatabase database,
	AFAnalysisTemplate template,
	AFSortField sortField,
	AFSortOrder sortOrder,
	int startIndex,
	int maxCount,
	out int totalCount
)

<BrowsableAttribute(false)>
<ObsoleteAttribute("This method has been replaced by the 'AFAnalysisSearch' class using the 'Template' filter.")>
Public Shared Function FindAnalysesByTemplate ( 
	database As AFDatabase,
	template As AFAnalysisTemplate,
	sortField As AFSortField,
	sortOrder As AFSortOrder,
	startIndex As Integer,
	maxCount As Integer,
	<OutAttribute> ByRef totalCount As Integer
) As AFNamedCollectionList(Of AFAnalysis)

Dim database As AFDatabase
Dim template As AFAnalysisTemplate
Dim sortField As AFSortField
Dim sortOrder As AFSortOrder
Dim startIndex As Integer
Dim maxCount As Integer
Dim totalCount As Integer
Dim returnValue As AFNamedCollectionList(Of AFAnalysis)

returnValue = AFAnalysis.FindAnalysesByTemplate(database, 
	template, sortField, sortOrder, startIndex, 
	maxCount, totalCount)

public:
[BrowsableAttribute(false)]
[ObsoleteAttribute(L"This method has been replaced by the 'AFAnalysisSearch' class using the 'Template' filter.")]
static AFNamedCollectionList<AFAnalysis^>^ FindAnalysesByTemplate(
	AFDatabase^ database, 
	AFAnalysisTemplate^ template, 
	AFSortField sortField, 
	AFSortOrder sortOrder, 
	int startIndex, 
	int maxCount, 
	[OutAttribute] int% totalCount
)

[<BrowsableAttribute(false)>]
[<ObsoleteAttribute("This method has been replaced by the 'AFAnalysisSearch' class using the 'Template' filter.")>]
static member FindAnalysesByTemplate : 
        database : AFDatabase * 
        template : AFAnalysisTemplate * 
        sortField : AFSortField * 
        sortOrder : AFSortOrder * 
        startIndex : int * 
        maxCount : int * 
        totalCount : int byref -> AFNamedCollectionList<AFAnalysis> 

Parameters

database

Type: OSIsoft.AFAFDatabase
The AFDatabase to search for the requested objects.

template

Type: OSIsoft.AF.AnalysisAFAnalysisTemplate
Specify that the returned analyses must have this template If , then all analyses without any template will be returned.

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

For AF 2.7 or later servers, this method is equivalent to calling the FindAnalyses(AFDatabase, String, String, NullableInt16, AFCategory, AFAnalysisTemplate, AFElement, AFStatus, AFSortField, AFSortOrder, Int32, Int32) method and only specifying template parameter. For older servers, this method is equivalent to calling the FindAnalyses(AFDatabase, String, AFSearchField, AFSortField, AFSortOrder, Int32, Int32, Int32) method and specifying Template for the search field and the template name for the query.

If the total count of objects is not needed, then the method which does not return the total count will provide better performance than this method. Only call this method when the total count is required. For example, you could call this method to get the first page with the total count and then call the other method for the remaining pages.

Important
Consider using the new AFAnalysisSearch class for finding analyses instead of using this method.

AFSDK

Reference