AFEventFrameSearch Constructor (AFDatabase, String, AFEventFrameSearchMode, AFTime, String)
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Creates an instance of an AFEventFrameSearch to search
for AFEventFrame 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 AFEventFrameSearch( AFDatabase database, string name, AFEventFrameSearchMode searchMode, AFTime startTime, string query = null )
Public Sub New ( database As AFDatabase, name As String, searchMode As AFEventFrameSearchMode, startTime As AFTime, Optional query As String = Nothing ) Dim database As AFDatabase Dim name As String Dim searchMode As AFEventFrameSearchMode Dim startTime As AFTime Dim query As String Dim instance As New AFEventFrameSearch(database, name, searchMode, startTime, query)
public: AFEventFrameSearch( AFDatabase^ database, String^ name, AFEventFrameSearchMode searchMode, AFTime startTime, String^ query = nullptr )
new : database : AFDatabase * name : string * searchMode : AFEventFrameSearchMode * startTime : AFTime * ?query : string (* Defaults: let _query = defaultArg query null *) -> AFEventFrameSearch
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 event frames. - 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 event frame based on the searchMode parameter. - query (Optional)
- Type: SystemString
The optional search query string. If specified, this will add additional search filters to the generated search query in addition to the ones for the specified mode and times. Strings will be interpreted with the Parse(String, AFTime, IFormatProvider) method so that relative formats with intervals ("*", "T+3h", etc.) are also supported. Relative time intervals are based on the database's QueryDate.
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 optional
query 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.