Click or drag to resize
OSIsoft, LLC

AFSearchToken Structure

Note: This API is now obsolete.

Represents one criteria of a search clause for AFSearch based searches.

Namespace:  OSIsoft.AF.Search
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.8.440
Syntax
[SerializableAttribute]
[ObsoleteAttribute("Use the AFSearchTokenBase derived classes. This structure cannot support Or tokens.")]
public struct AFSearchToken : IEquatable<AFSearchToken>

The AFSearchToken type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyFilter
The filter to be searched using the specified Operator and Value.
Public propertyOperator
The search operator to perform on the search filter with the specified Value.
Public propertyPath
The path of an attribute, relative to an element, used when the Filter is Value.
Public propertyTokens
The collection of search tokens to be used for a nested query.
Public propertyValue
The value to compare the search filter on using the specified Operator.
Public propertyValues
The array of values to compare the search filter on using the specified Operator.
Public propertyValueType
This is the value type of the specified Value.
Top
Methods
  NameDescription
Public methodEquals(Object)
Determines whether the specified Object is equal to the current object.
(Overrides ValueTypeEquals(Object).)
Public methodEquals(AFSearchToken)
Indicates whether the current object is equal to another object of the same type.
Public methodGetHashCode
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 ValueTypeGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a String that represents the current object.
(Overrides ValueTypeToString.)
Public methodStatic memberToString(IEnumerableAFSearchToken)
This method will return a String that represents the list of AFSearchToken objects.
Top
Operators
  NameDescription
Public operatorStatic memberEquality
The equality operator (==) compares its operands to determine if they are equal.
Public operatorStatic member(AFSearchToken to AFSearchTokenBase)
Casts an AFSearchToken as an AFSearchTokenBase.
Public operatorStatic memberInequality
The inequality operator (!=) compares its operands to determine if they are not equal.
Top
Fields
  NameDescription
Public fieldStatic memberEmpty
Represents the empty AFSearchToken.
Top
Remarks

This structure 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.

The AFSearchFilter and AFSearchOperator topics provide more information about the filters and operators that can be used in a search token.

Version Information

AFSDK

Supported in: 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5
Obsolete (compiler warning) in 2.10.5
See Also
Enabling Operational Intelligence