AFAnalysis.FindAnalysesByGroupID Method (PISystem, Int16, AFSortField, AFSortOrder, Int32, Int32, Int32)

Save PDF

Feedback

HomeAF SDK Reference...NamespacesOSIsoft.AF.AnalysisAFAnalysis ClassAFAnalysis MethodsFindAnalysesByGroupID Method AFAnalysis.FindAnalysesByGroupID Method (PISystem, Int16, AFSortField, AFSortOrder, Int32, Int32, Int32)

TABLE OF CONTENTS

AFAnalysis.FindAnalysesByGroupID Method (PISystem, Int16, AFSortField, AFSortOrder, Int32, Int32, Int32)

Save PDF

Feedback

Last UpdatedSep 18, 2024

Note: This API is now obsolete.

Performs a paged search to retrieve a collection of all AFAnalysis objects in the specified PISystem with the specified group identifier.

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

Syntax

[BrowsableAttribute(false)]
[ObsoleteAttribute("This method has been replaced by the 'AFAnalysisSearch' class using the 'GroupID' filter.")]
public static AFNamedCollectionList<AFAnalysis> FindAnalysesByGroupID(
	PISystem system,
	short groupID,
	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 'GroupID' filter.")>
Public Shared Function FindAnalysesByGroupID ( 
	system As PISystem,
	groupID As Short,
	sortField As AFSortField,
	sortOrder As AFSortOrder,
	startIndex As Integer,
	maxCount As Integer,
	<OutAttribute> ByRef totalCount As Integer
) As AFNamedCollectionList(Of AFAnalysis)

Dim system As PISystem
Dim groupID As Short
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.FindAnalysesByGroupID(system, 
	groupID, sortField, sortOrder, startIndex, 
	maxCount, totalCount)

public:
[BrowsableAttribute(false)]
[ObsoleteAttribute(L"This method has been replaced by the 'AFAnalysisSearch' class using the 'GroupID' filter.")]
static AFNamedCollectionList<AFAnalysis^>^ FindAnalysesByGroupID(
	PISystem^ system, 
	short groupID, 
	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 'GroupID' filter.")>]
static member FindAnalysesByGroupID : 
        system : PISystem * 
        groupID : int16 * 
        sortField : AFSortField * 
        sortOrder : AFSortOrder * 
        startIndex : int * 
        maxCount : int * 
        totalCount : int byref -> AFNamedCollectionList<AFAnalysis>

Parameters

system: Type: OSIsoft.AF.PISystem
The PISystem to search for the requested objects.
groupID: Type: System.Int16
The specified group identifier object to match.
sortField: Type: OSIsoft.AF.AFSortField
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.AF.AFSortOrder
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: System.Int32
The starting index (zero based) of the items to be returned.
maxCount: Type: System.Int32
The maximum number of objects to be returned per call (the page size).
totalCount: Type: System.Int32
The total number of objects that match the search criteria.

Return Value

Type: AFNamedCollectionList<AFAnalysis>
Returns the collection containing the specified page of AFAnalysis objects which match the specified groupID.

Remarks

This search returns all the AFAnalysis objects within the specified PISystem where its GroupID equals the specified groupID.

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

Version Information

AFSDK

Supported in: 2.8.5, 2.8, 2.7.5, 2.7, 2.6
Obsolete (compiler warning) in 3.1.0
Obsolete (compiler warning) in 3.0.2
Obsolete (compiler warning) in 3.0.1
Obsolete (compiler warning) in 3.0.0
Obsolete (compiler warning) in 2.10.11
Obsolete (compiler warning) in 2.10.5
Obsolete (compiler warning) in 2.10.0
Obsolete (compiler warning) in 2.10
Obsolete (compiler warning) in 2.9.5
Obsolete (compiler warning) in 2.9

AF SDK Reference

Filters

Product Family