AFSearch.TryFindSearchToken Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Note: This API is now obsolete.
Find the AFSearchToken associated with the specified AFSearchFilter.
Namespace: OSIsoft.AF.Search
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
[ObsoleteAttribute("Use TokenCollection.TryFindSearchToken instead.")] public bool TryFindSearchToken( AFSearchFilter filter, out AFSearchToken token )
<ObsoleteAttribute("Use TokenCollection.TryFindSearchToken instead.")> Public Function TryFindSearchToken ( filter As AFSearchFilter, <OutAttribute> ByRef token As AFSearchToken ) As Boolean Dim instance As AFSearch Dim filter As AFSearchFilter Dim token As AFSearchToken Dim returnValue As Boolean returnValue = instance.TryFindSearchToken(filter, token)
public: [ObsoleteAttribute(L"Use TokenCollection.TryFindSearchToken instead.")] virtual bool TryFindSearchToken( AFSearchFilter filter, [OutAttribute] AFSearchToken% token ) sealed
[<ObsoleteAttribute("Use TokenCollection.TryFindSearchToken instead.")>] abstract TryFindSearchToken : filter : AFSearchFilter * token : AFSearchToken byref -> bool [<ObsoleteAttribute("Use TokenCollection.TryFindSearchToken instead.")>] override TryFindSearchToken : filter : AFSearchFilter * token : AFSearchToken byref -> bool
Parameters
- filter
- Type: OSIsoft.AF.SearchAFSearchFilter
The AFSearchFilter for the desired search token. - token
- Type: OSIsoft.AF.SearchAFSearchToken
The found token that matches the specified filter. If not found, then null is returned as this parameter.
Return Value
Type: BooleanReturns if the token that matches the specified filter was found. Otherwise, is returned.
Version Information
AFSDK
Supported in: 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5Obsolete (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