|
virtual void | Release ()=0 |
| A callback function used to release current callback object itself. More...
|
|
virtual int | RetrieveSearchResult (const wchar_t *file_path, int page_index, const WString &match_result, int match_start_text_index, int match_end_text_index, const WString &sentence, int match_sentence_start_text_index, int match_sentence_end_text_index)=0 |
| A callback function used to retrieve the searching result. More...
|
|
This class represents a callback object to retrieve the searching result during the searching progress by function FullTextSearch::SearchOf. All the pure virtual functions in this class are used as callback functions and should be implemented by user.
- See also
- FullTextSearch
◆ Release()
virtual void foxit::fts::SearchCallback::Release |
( |
| ) |
|
|
pure virtual |
A callback function used to release current callback object itself.
- Returns
- None.
◆ RetrieveSearchResult()
virtual int foxit::fts::SearchCallback::RetrieveSearchResult |
( |
const wchar_t * |
file_path, |
|
|
int |
page_index, |
|
|
const WString & |
match_result, |
|
|
int |
match_start_text_index, |
|
|
int |
match_end_text_index, |
|
|
const WString & |
sentence, |
|
|
int |
match_sentence_start_text_index, |
|
|
int |
match_sentence_end_text_index |
|
) |
| |
|
pure virtual |
A callback function used to retrieve the searching result.
- Parameters
-
[in] | file_path | A file path that specifies in which file the matched result is found. |
[in] | page_index | A page index that specifies in which page of the file the matched result is found. |
[in] | match_result | A string that represents the matched result. |
[in] | match_start_text_index | The index of start character in the matched result. |
[in] | match_end_text_index | The index of end character in the matched result. |
[in] | sentence | The sentence that contains current match result. |
[in] | match_sentence_start_text_index | The index of start character in the sentence. |
[in] | match_sentence_end_text_index | The index of end character in the sentence. |
- Returns
- If non-zero is returned, the search engine will stop searching.