AF SDK Reference

AFSearchToken Structure

Save PDF

TABLE OF CONTENTS

AFSearchToken Structure

Save PDF

Last UpdatedNov 18, 2025
6 minute read

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: 3.1.1.1182

Syntax

[SerializableAttribute]
[ObsoleteAttribute("Use the AFSearchTokenBase derived classes. This structure cannot support Or tokens.")]
public struct AFSearchToken : IEquatable<AFSearchToken>

<SerializableAttribute>
<ObsoleteAttribute("Use the AFSearchTokenBase derived classes. This structure cannot support Or tokens.")>
Public Structure AFSearchToken
	Implements IEquatable(Of AFSearchToken)

Dim instance As AFSearchToken

[SerializableAttribute]
[ObsoleteAttribute(L"Use the AFSearchTokenBase derived classes. This structure cannot support Or tokens.")]
public value class AFSearchToken : IEquatable<AFSearchToken>

[<SealedAttribute>]
[<SerializableAttribute>]
[<ObsoleteAttribute("Use the AFSearchTokenBase derived classes. This structure cannot support Or tokens.")>]
type AFSearchToken =  
    struct
        interface IEquatable<AFSearchToken>
    end

The AFSearchToken type exposes the following members.

Constructors

	Name	Description
	AFSearchToken(String, String, String)	Creates an AFSearchToken instance with the Values, Path, and ValueType specified. The Filter will be set to Value and the Operator will be set to In.
	AFSearchToken(AFSearchFilter, String, String)	Creates an AFSearchToken instance for the Filter, Equal operator, Value, and optionally Path specified.
	AFSearchToken(AFSearchFilter, AFSearchOperator, String, IListAFSearchToken)	Creates an AFSearchToken instance for the Filter, Operator, Value, and Tokens properties specified.
	AFSearchToken(AFSearchFilter, AFSearchOperator, String, String)	Creates an AFSearchToken instance for the Filter, Operator, Value, and optionally Path specified.
	AFSearchToken(AFSearchFilter, AFSearchOperator, String, String)	Creates an AFSearchToken instance for the Filter, Operator, Values, and Path specified.
	AFSearchToken(AFSearchOperator, String, String, String)	Creates an AFSearchToken instance with the Operator, Value, Path, and ValueType specified. The Filter will be set to Value.

Properties

	Name	Description
	Filter	The filter to be searched using the specified Operator and Value.
	Operator	The search operator to perform on the search filter with the specified Value.
	Path	The path of an attribute, relative to an element, used when the Filter is Value.
	Tokens	The collection of search tokens to be used for a nested query.
	Value	The value to compare the search filter on using the specified Operator.
	Values	The array of values to compare the search filter on using the specified Operator.
	ValueType	This is the value type of the specified Value.

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current object. (Overrides ValueTypeEquals(Object).)
	Equals(AFSearchToken)	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 ValueTypeGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a String that represents the current object. (Overrides ValueTypeToString.)
	ToString(IEnumerableAFSearchToken)	This method will return a String that represents the list of AFSearchToken objects.

Operators

	Name	Description
	Equality	The equality operator (==) compares its operands to determine if they are equal.
	(AFSearchToken to AFSearchTokenBase)	Casts an AFSearchToken as an AFSearchTokenBase.
	Inequality	The inequality operator (!=) compares its operands to determine if they are not equal.

Fields

	Name	Description
	Empty	Represents the empty AFSearchToken.

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.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5
Obsolete (compiler warning) in 3.1.1
Obsolete (compiler warning) in 3.1.0
Obsolete (compiler warning) in 3.0.2
Obsolete (compiler warning) in 3.0.1
Obsolete (compiler warning) in 3.0.0
Obsolete (compiler warning) in 2.10.11
Obsolete (compiler warning) in 2.10.5

AF SDK Reference