AFSearchTokenBase Class
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
Represents criteria of a search clause for AFSearch based searches.
Inheritance Hierarchy
SystemObject
OSIsoft.AF.SearchAFSearchTokenBase
OSIsoft.AF.SearchAFSearchExpressionToken
OSIsoft.AF.SearchAFSearchFilterToken
OSIsoft.AF.SearchAFSearchTokenBase
OSIsoft.AF.SearchAFSearchExpressionToken
OSIsoft.AF.SearchAFSearchFilterToken
Namespace: OSIsoft.AF.Search
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[SerializableAttribute] public abstract class AFSearchTokenBase : IEquatable<AFSearchTokenBase>
<SerializableAttribute> Public MustInherit Class AFSearchTokenBase Implements IEquatable(Of AFSearchTokenBase) Dim instance As AFSearchTokenBase
[SerializableAttribute] public ref class AFSearchTokenBase abstract : IEquatable<AFSearchTokenBase^>
[<AbstractClassAttribute>] [<SerializableAttribute>] type AFSearchTokenBase = class interface IEquatable<AFSearchTokenBase> end
The AFSearchTokenBase type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | Filter |
The filter to be searched with the current token.
|
Methods
| Name | Description | |
|---|---|---|
 | Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Overrides ObjectEquals(Object).) |
| Equals(AFSearchTokenBase) |
Indicates whether the current object is equal to another object of the same type.
|
| GetHashCode |
Gets the hash code for this instance of the object which is suitable for use in hashing
algorithms and data structures like a hash table.
(Overrides ObjectGetHashCode.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
 | ToString(IListAFSearchTokenBase) |
This method will return a String that represents
the list of AFSearchTokenBase objects.
|
Operators
| Name | Description | |
|---|---|---|
 | Equality |
The equality operator (==) compares its operands to determine if they are equal.
|
| (AFSearchTokenBase to AFSearchToken) | Obsolete.
Casts an AFSearchTokenBase object as an AFSearchToken.
|
| Inequality |
The inequality operator (!=) compares its operands to determine if they are not equal.
|
Remarks
This class represents the information about a search query token created when parsing a search query. These tokens can be used to perform a search for objects from the server. This class cannot be instantiated.
The AFSearchFilter and AFSearchOperator topics provide more information about the filters and operators that can be used in a search token.