get_matches_to


Description:

public Array<Accessible> get_matches_to (Accessible current_object, MatchRule rule, CollectionSortOrder sortby, CollectionTreeTraversalType tree, bool limit_scope, int count, bool traverse) throws Error

Gets all Accessible objects from the this, after current_object, matching a given rule.

Parameters:

this

A pointer to the Collection to query.

current_object

The object at which to start searching.

rule

An MatchRule describing the match criteria.

sortby

An CollectionSortOrder specifying the way the results are to be sorted.

tree

An CollectionTreeTraversalType specifying restrictions on the objects to be traversed.

limit_scope

If TRUE, only descendants of current_object's parent will be returned. Otherwise (if FALSE), any accessible may be returned if it would preceed current_object in a flattened hierarchy.

count

The maximum number of results to return, or 0 for no limit.

traverse

Not supported.

Returns:

All Accessible objects matching the given match rule after current_object.