AFSearchTokenCollection.TryFindSearchToken Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Find the AFSearchTokenBase associated with the specified AFSearchFilter.
Namespace: OSIsoft.AF.Search
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public bool TryFindSearchToken( AFSearchFilter filter, out AFSearchTokenBase token )
Public Function TryFindSearchToken ( filter As AFSearchFilter, <OutAttribute> ByRef token As AFSearchTokenBase ) As Boolean Dim instance As AFSearchTokenCollection Dim filter As AFSearchFilter Dim token As AFSearchTokenBase Dim returnValue As Boolean returnValue = instance.TryFindSearchToken(filter, token)
public: bool TryFindSearchToken( AFSearchFilter filter, [OutAttribute] AFSearchTokenBase^% token )
member TryFindSearchToken : filter : AFSearchFilter * token : AFSearchTokenBase byref -> bool
Parameters
- filter
- Type: OSIsoft.AF.SearchAFSearchFilter
The AFSearchFilter for the desired search token. - token
- Type: OSIsoft.AF.SearchAFSearchTokenBase
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.