AFSearchValueToken Constructor (String, String, AFSearchOperator, AFSearchValueType, String)
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
Creates an AFSearchValueToken instance for the Path and Value.
Optionally, the Operator, ValueType, and ValueTypeQualifier may be set.
Namespace: OSIsoft.AF.Search
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public AFSearchValueToken( string path, string value, AFSearchOperator searchOperator = AFSearchOperator.Equal, AFSearchValueType valueType = AFSearchValueType.None, string valueTypeQualifier = null )
Public Sub New ( path As String, value As String, Optional searchOperator As AFSearchOperator = AFSearchOperator.Equal, Optional valueType As AFSearchValueType = AFSearchValueType.None, Optional valueTypeQualifier As String = Nothing ) Dim path As String Dim value As String Dim searchOperator As AFSearchOperator Dim valueType As AFSearchValueType Dim valueTypeQualifier As String Dim instance As New AFSearchValueToken(path, value, searchOperator, valueType, valueTypeQualifier)
public: AFSearchValueToken( String^ path, String^ value, AFSearchOperator searchOperator = AFSearchOperator::Equal, AFSearchValueType valueType = AFSearchValueType::None, String^ valueTypeQualifier = nullptr )
new : path : string * value : string * ?searchOperator : AFSearchOperator * ?valueType : AFSearchValueType * ?valueTypeQualifier : string (* Defaults: let _searchOperator = defaultArg searchOperator AFSearchOperator.Equal let _valueType = defaultArg valueType AFSearchValueType.None let _valueTypeQualifier = defaultArg valueTypeQualifier null *) -> AFSearchValueToken
Parameters
- path
- Type: SystemString
The path of an attribute, relative to an element. - value
- Type: SystemString
The search value used to initialize the Value property. - searchOperator (Optional)
- Type: OSIsoft.AF.SearchAFSearchOperator
The search operator used to initialize the Operator property. - valueType (Optional)
- Type: OSIsoft.AF.SearchAFSearchValueType
The AFSearchValueType of values to use in the value query. If set to EnumerationSet, valueTypeQualifier must be set to the Name of an AFEnumerationSet. - valueTypeQualifier (Optional)
- Type: SystemString
The Name of an AFEnumerationSet if valueType is set to EnumerationSet. Otherwise, this parameter will be ignored.
Remarks
This constructor is used to create a search token with values for the AFSearchValueToken
instance for the Path and Value.
The Filter will be set to Value.
The Operator will be set to the Equal
operator unless specified.
The ValueType will be set to None unless specified.
The ValueTypeQualifier will be set to Empty unless specified and must be set
if ValueType is set to EnumerationSet.