IndexManager :: Search - Search objects by keyword

The function provides the objects matching the keywords passed in the search string.

The matching objects are returned in a collection ordered by weight, i.e. the objects matching most keywords are returned first. The result collection does not have a key, but can be accessed by position, only. The collection only contains the matching instances but no weight information.

The result collection can be passed by the application as opened property handle collection containing the result collection. When the passed result property handle is not opened, the function creates a transient collection which will be returned in the property handle. When passing an opened collection, the collection must be defined with type VOID or as weak-typed collection with a valid base type for the instances in the result collection.

In typenames the type of objects to be selected can be passed in case of type list indexes . When the index has been created without type lists, passing a typename with result in an empty collection. For getting all matching objects for the keyword, NULL or "" should be passed in typenames .

In many cases it makes sense to limit the number of objects to be returned in the result collection, since this will increase performance of the search function.