You are here: Symbol Reference
Symbol Reference
> Ofcas.Lk.Api.Client.Core Namespace > Classes > SearchAgent Class > SearchAgent Methods > SearchAgent.BeginFind Method
SearchAgent.BeginFind Method
Close
Ofcas.Lk.Api.Client - Version 3.0
SearchAgent.BeginFind Method

Starts a search. The search results are returned as messages over the Synchronization interface (ISynchronizationContainer). The results are accessible through the message list (ISynchronizationContainer.TakeMessages). The included items in the list are from type SearchResult, which allows to get the metadata of the item as an info object (e.g. ProjectInfo).

Syntax
C#
public ISynchronizedOperation BeginFind(Dictionary<string, object> parameters);
Parameters
Description
Dictionary<string, object> parameters
A dictionary with parameters can be used to specify the search options, see WellKnownParameterKeys.SearchAgent.

Returns a ISynchronizedOperation for the async method.

Copyright © 2020. All rights reserved.