forward


Description:

public bool forward (TextIter iter, out TextIter match_start, out TextIter match_end, out bool has_wrapped_around)

Synchronous forward search.

It is recommended to use the asynchronous functions instead, to not block the user interface. However, if you are sure that the buffer is small, this function is more convenient to use.

If the [property@SearchSettings:wrap-around] property is false, this function doesn't try to wrap around.

The has_wrapped_around out parameter is set independently of whether a match is found. So if this function returns false, has_wrapped_around will have the same value as the [property@SearchSettings:wrap-around] property.

Parameters:

this

a SearchContext.

iter

start of search.

match_start

return location for start of match, or null.

match_end

return location for end of match, or null.

has_wrapped_around

return location to know whether the search has wrapped around, or null.

Returns:

whether a match was found.