IAFSearch(T) Interface

[ObsoleteAttribute("Use AFSearch<T> instead.")]
public interface IAFSearch<T>

<ObsoleteAttribute("Use AFSearch<T> instead.")>
Public Interface IAFSearch(Of T)

Dim instance As IAFSearch(Of T)

[ObsoleteAttribute(L"Use AFSearch<T> instead.")]
generic<typename T>
public interface class IAFSearch

[<ObsoleteAttribute("Use AFSearch<T> instead.")>]
type IAFSearch<'T> =  interface end

Type Parameters

T

The type of object that is returned from the search class.

This is a common generic interface to the properties and methods of the actual classes that implement the query based searches for objects. The QuerySearch feature can be checked to determine if query searches are supported.

A query string is parsed into search tokens which are used to specify the query filters for the search.

To optimize getting items from several pages of search results, a search can be cached by setting the CacheTimeout to a non-zero value. If you will only be getting items from the first page, then it is best to leave the cache disabled. The cache is disabled by default. Call the Refresh method to refresh the results of a cached search. Use the Close method to close a cached search when finished using it to free the memory used by the cached results in the server. Since the search implements the IDisposable interface, you can call the cached search in a using statement to automatically call the Close method when it leaves scope.

Notes to Callers
When a query is too complex for a server, then you will get a NotSupportedException.

AFSDK

Reference

Other Resources