AFSearchMode Enumeration
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
The search mode is an enumeration of the possible values for specifying the
search criteria.
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public enum AFSearchMode
Public Enumeration AFSearchMode Dim instance As AFSearchMode
public enum class AFSearchMode
type AFSearchMode
Members
| Member name | Value | Description | |
|---|---|---|---|
| None | 0 | This is the value of an uninitialized search mode. | |
| StartInclusive | 1 | Includes all objects whose start time is within the specified range. Also known as "Starting Between". | |
| EndInclusive | 2 | Includes all objects whose end time is within the specified range. Also known as "Ending Between". | |
| Inclusive | 3 | Includes all objects whose start and end time are within the specified range. Also know as "Entirely Between". | |
| Overlapped | 4 | Includes all objects whose time range overlaps with the specified range at any point in time. Also known as "Active Between". | |
| InProgress | 5 | Includes all objects whose start time is within the specified range and end time is MaxValue. Also known as "Starting Between and In Progress". |
Remarks
The search mode specifies which values are returned relative to the search's start and end times.
The diagram below shows several possible time spans for the value of an object and illustrates which would be returned for each of the search modes. The InProgressSearch feature can be checked to determine if InProgress is supported.
 Important |
|---|
| Note that objects which end on the search start time or start on the search end time are not included as part of the returned collection. |
