AF SDK Reference

AFSearch.TryFindSearchTokens Method

Save PDF

TABLE OF CONTENTS

AFSearch.TryFindSearchTokens Method

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Note: This API is now obsolete.

Find the AFSearchToken list 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.TryFindSearchTokens instead.")]
public bool TryFindSearchTokens(
	AFSearchFilter filter,
	out IList<AFSearchToken> tokens
)

<ObsoleteAttribute("Use TokenCollection.TryFindSearchTokens instead.")>
Public Function TryFindSearchTokens ( 
	filter As AFSearchFilter,
	<OutAttribute> ByRef tokens As IList(Of AFSearchToken)
) As Boolean

Dim instance As AFSearch
Dim filter As AFSearchFilter
Dim tokens As IList(Of AFSearchToken)
Dim returnValue As Boolean

returnValue = instance.TryFindSearchTokens(filter, 
	tokens)

public:
[ObsoleteAttribute(L"Use TokenCollection.TryFindSearchTokens instead.")]
virtual bool TryFindSearchTokens(
	AFSearchFilter filter, 
	[OutAttribute] IList<AFSearchToken>^% tokens
) sealed

[<ObsoleteAttribute("Use TokenCollection.TryFindSearchTokens instead.")>]
abstract TryFindSearchTokens : 
        filter : AFSearchFilter * 
        tokens : IList<AFSearchToken> byref -> bool 
[<ObsoleteAttribute("Use TokenCollection.TryFindSearchTokens instead.")>]
override TryFindSearchTokens : 
        filter : AFSearchFilter * 
        tokens : IList<AFSearchToken> byref -> bool

Parameters

filter: Type: OSIsoft.AF.SearchAFSearchFilter
The AFSearchFilter for the desired search tokens.
tokens: Type: System.Collections.GenericIListAFSearchToken
The list of found tokens that matches the specified filter. If not found, then an empty list is returned for this parameter.

Return Value

Type: Boolean
Returns if any tokens that matches the specified filter were 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.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