Click or drag to resize
OSIsoft, LLC

AFSearchMode Enumeration

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: 2.10.8.440
Syntax
public enum AFSearchMode
Members
  Member nameValueDescription
None0 This is the value of an uninitialized search mode.
StartInclusive1 Includes all objects whose start time is within the specified range. Also known as "Starting Between".
EndInclusive2 Includes all objects whose end time is within the specified range. Also known as "Ending Between".
Inclusive3 Includes all objects whose start and end time are within the specified range. Also know as "Entirely Between".
Overlapped4 Includes all objects whose time range overlaps with the specified range at any point in time. Also known as "Active Between".
InProgress5 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 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.

Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5, 2.4
See Also
Enabling Operational Intelligence