Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

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

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

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFAnalysis.FindAnalysesByGroupID Method (AFDatabase, Int16, AFSortField, AFSortOrder, Int32)

Note: This API is now obsolete.

Performs a non-paged search within the AFDatabase to retrieve a collection of AFAnalysis objects with the specified group identifier.

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

Syntax

[BrowsableAttribute(false)]
[ObsoleteAttribute("This method has been replaced by the 'AFAnalysisSearch' class using the 'GroupID' filter.")]
public static AFNamedCollectionList<AFAnalysis> FindAnalysesByGroupID(
	AFDatabase database,
	short groupID,
	AFSortField sortField,
	AFSortOrder sortOrder,
	int maxCount
)
<BrowsableAttribute(false)>
<ObsoleteAttribute("This method has been replaced by the 'AFAnalysisSearch' class using the 'GroupID' filter.")>
Public Shared Function FindAnalysesByGroupID ( 
	database As AFDatabase,
	groupID As Short,
	sortField As AFSortField,
	sortOrder As AFSortOrder,
	maxCount As Integer
) As AFNamedCollectionList(Of AFAnalysis)

Dim database As AFDatabase
Dim groupID As Short
Dim sortField As AFSortField
Dim sortOrder As AFSortOrder
Dim maxCount As Integer
Dim returnValue As AFNamedCollectionList(Of AFAnalysis)

returnValue = AFAnalysis.FindAnalysesByGroupID(database, 
	groupID, sortField, sortOrder, maxCount)
public:
[BrowsableAttribute(false)]
[ObsoleteAttribute(L"This method has been replaced by the 'AFAnalysisSearch' class using the 'GroupID' filter.")]
static AFNamedCollectionList<AFAnalysis^>^ FindAnalysesByGroupID(
	AFDatabase^ database, 
	short groupID, 
	AFSortField sortField, 
	AFSortOrder sortOrder, 
	int maxCount
)
[<BrowsableAttribute(false)>]
[<ObsoleteAttribute("This method has been replaced by the 'AFAnalysisSearch' class using the 'GroupID' filter.")>]
static member FindAnalysesByGroupID : 
        database : AFDatabase * 
        groupID : int16 * 
        sortField : AFSortField * 
        sortOrder : AFSortOrder * 
        maxCount : int -> AFNamedCollectionList<AFAnalysis> 

Parameters

database
Type: OSIsoft.AFAFDatabase
The AFDatabase to search for the requested objects.
groupID
Type: SystemInt16
The specified group identifier object to match.
sortField
Type: OSIsoft.AFAFSortField
The field or property of the object used to sort the returned collection.
sortOrder
Type: OSIsoft.AFAFSortOrder
The order that the returned collection is sorted.
maxCount
Type: SystemInt32
The maximum number of objects to be returned.

Return Value

Type: AFNamedCollectionListAFAnalysis
Returns the collection containing the first page of AFAnalysis objects which match the specified groupID.

Remarks

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

Important note 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.1
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

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in