AFSearchField Enumeration
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Defines the fields of the object that are searched.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[FlagsAttribute] public enum AFSearchField
<FlagsAttribute> Public Enumeration AFSearchField Dim instance As AFSearchField
[FlagsAttribute] public enum class AFSearchField
[<FlagsAttribute>] type AFSearchField
Members
| Member name | Value | Description | |
|---|---|---|---|
| Name | 1 | The object's Name property is searched. | |
| Description | 2 | The object's Description property is searched. | |
| Categories | 4 | The object's Categories collection property is searched by name. If only searching categories and the query for the search is or empty string, then only items without a category are returned. | |
| Template | 8 | The object's Template property is searched. If only searching the template and the query for the search is or empty string, then only items without a template are returned. | |
| Department | 16 | The object's Department property is searched. | |
| 32 | The object's EMail property is searched for objects defined by Active Directory. |
Remarks
The find methods use this enumeration to define which fields of
the object are searched.