Click or drag to resize
OSIsoft, LLC

AFSearchT Methods

The AFSearchT generic type exposes the following members.

Methods
  NameDescription
Public methodCode exampleAggregate
Performs all requested aggregates on the objects that match the search criteria.
(Inherited from AFSearch.)
Public methodCode exampleAggregateAsync
Performs all requested aggregates on the objects that match the search criteria asynchronously.
(Inherited from AFSearch.)
Public methodCode exampleBinnedSummaryTBin
Generates a summary broken down by the specified bins for items matching the search criteria.
(Inherited from AFSearch.)
Public methodCode exampleBinnedSummaryAsyncTBin
Generates a summary broken down by the specified bins for items matching the search criteria asynchronously.
(Inherited from AFSearch.)
Public methodClose
Closes the search that is cached in the server.
(Inherited from AFSearch.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodCode exampleFindObjectFields(String, Int32, Int32)
This method will return the values as an IList for the specified fields for each of the objects that match the search tokens.
(Overrides AFSearchFindObjectFields(String, Int32, Int32).)
Public methodCode exampleFindObjectFieldsTObject(Int32, Int32)
This method will return the values for the fields defined by the user-defined type for each of the objects that match the search tokens.
(Overrides AFSearchFindObjectFieldsTObject(Int32, Int32).)
Public methodCode exampleFindObjectFieldsTObject(String, FuncIListObject, TObject, Int32, Int32)
This method will return the values as an object for the specified fields for each of the objects that match the search tokens using the supplied factory delegate.
(Inherited from AFSearch.)
Public methodCode exampleFindObjectFieldsTObject(String, FuncIListObject, TObject, Int32, Int32)
This method will return the values as an object for the specified fields for each of the objects that match the search tokens using the supplied factory delegate.
(Overrides AFSearchFindObjectFieldsTObject(String, FuncIListObject, TObject, Int32, Int32).)
Public methodCode exampleFindObjectIds
This method will return a list of the ID for each object that matches the search tokens.
(Overrides AFSearchFindObjectIds(Int32, Int32).)
Public methodCode exampleFindObjects
This method will return the objects that match the search tokens.
Public methodCode exampleFrequencyDistribution
Generates a frequency distribution for the specified items.
(Inherited from AFSearch.)
Public methodCode exampleFrequencyDistributionAsync
Generates a frequency distribution for the specified items asynchronously.
(Inherited from AFSearch.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetTotalCount
Returns the total count of the items that could be returned from the search query.
(Overrides AFSearchGetTotalCount.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodCode exampleGroupedSummary
Generates summaries broken down by group for items matching the search criteria.
(Inherited from AFSearch.)
Public methodCode exampleGroupedSummaryAsync
Generates summaries broken down by group for items matching the search criteria asynchronously.
(Inherited from AFSearch.)
Public methodCode exampleHistogramTBin
Generates a histogram using the specified weighting for items matching this search.
(Inherited from AFSearch.)
Public methodCode exampleHistogramAsyncTBin
Generates a histogram using the specified weighting for items matching this search asynchronously.
(Inherited from AFSearch.)
Public methodCode exampleIsMatch
Determines if the specified item matches the search query.
Public methodRefresh
Refreshes the search that is cached in the server.
(Inherited from AFSearch.)
Public methodCode exampleSummary(String, AFSummaryTypes)
Summarizes the result of this search.
(Inherited from AFSearch.)
Public methodSummary(String, AFSummaryTypes, String)
Summarizes the result of this search with the specified weighting.
(Inherited from AFSearch.)
Public methodCode exampleSummaryAsync(String, AFSummaryTypes, CancellationToken)
Summarizes the result of this search asynchronously.
(Inherited from AFSearch.)
Public methodSummaryAsync(String, AFSummaryTypes, String, CancellationToken)
Summarizes the result of this search with the specified weighting asynchronously.
(Inherited from AFSearch.)
Public methodToString
Returns a String that represents the current object.
(Inherited from AFSearch.)
Public methodTryFindSearchToken Obsolete.
Find the AFSearchToken associated with the specified AFSearchFilter.
(Inherited from AFSearch.)
Public methodTryFindSearchTokens Obsolete.
Find the AFSearchToken list associated with the specified AFSearchFilter.
(Inherited from AFSearch.)
Top
See Also
Enabling Operational Intelligence