AFTransferSearch Constructor (AFDatabase, String, AFEventFrameSearchMode, AFTime, IList(AFSearchTokenBase))
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Creates an instance of an AFTransferSearch to search
for AFTransfer objects using the specified AFEventFrameSearchMode,
time and optional search query string.
Namespace: OSIsoft.AF.Search
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFTransferSearch( AFDatabase database, string name, AFEventFrameSearchMode searchMode, AFTime startTime, IList<AFSearchTokenBase> tokens )
Public Sub New ( database As AFDatabase, name As String, searchMode As AFEventFrameSearchMode, startTime As AFTime, tokens As IList(Of AFSearchTokenBase) ) Dim database As AFDatabase Dim name As String Dim searchMode As AFEventFrameSearchMode Dim startTime As AFTime Dim tokens As IList(Of AFSearchTokenBase) Dim instance As New AFTransferSearch(database, name, searchMode, startTime, tokens)
public: AFTransferSearch( AFDatabase^ database, String^ name, AFEventFrameSearchMode searchMode, AFTime startTime, IList<AFSearchTokenBase^>^ tokens )
new : database : AFDatabase * name : string * searchMode : AFEventFrameSearchMode * startTime : AFTime * tokens : IList<AFSearchTokenBase> -> AFTransferSearch
Parameters
- database
- Type: OSIsoft.AFAFDatabase
The AFDatabase to be searched by the query. This parameter will initialize the Database property. - name
- Type: SystemString
The SearchName associated with the created search object. This is only informational and does not affect the searches. - searchMode
- Type: OSIsoft.AF.EventFrameAFEventFrameSearchMode
The AFEventFrameSearchMode to be converted into a search query which indicates the direction in time from the StartTime or EndTime to proceed when returning transfers. - startTime
- Type: OSIsoft.AF.TimeAFTime
The starting time to be used in the generated search query. The search may compare against either the StartTime or EndTime of the transfer based on the searchMode parameter. - tokens
- Type: System.Collections.GenericIListAFSearchTokenBase
The list of tokens to initialize the TokenCollection property for the new object and will be used when calling search method. A query string can be converted to a list of tokens by calling the ParseQueryString(String) method.
Remarks
This constructor will create a search query based upon the specified searchMode
and time. The times in the query string will have the correct operators specified for the
Start and/or End filters. The
tokens will be used to add additional search filters to the search query.
These parameters will be used to create tokens and initialize the TokenCollection property.