search_result_data_t Struct Reference

Opaque handle owning a set of search results returned by the indexer. More...

#include <indexer.hpp>

Public Member Functions
virtual	~search_result_data_t ()
virtual size_t	size () const =0
	Number of results.
virtual std::string_view	get_name (size_t index) const =0
	Name of result at index.
virtual const qstring &	get_name_str (size_t index) const =0
	Name of result at index, as a qstring reference.
virtual int	get_score (size_t index) const =0
	Match score of result at index, in percent [0, 100].
virtual ea_t	get_ea (size_t index) const =0
	Effective address of result at index, or BADADDR for local types.
virtual nodeidx_t	get_netnode_idx (size_t index) const =0
	Netnode index of result at index.
virtual int	get_ltype_ordinal (size_t index) const =0
	Local type ordinal of result at index, or 0 if not a local type.
virtual type_t	get_ltype_type (size_t index) const =0
	BT_* type code of the local type at index (valid when get_ltype_ordinal() != 0).
virtual subindex_typeid_t	get_subindex (size_t index) const =0
	Sub-index that produced result at index (e.g. SUBIDX_FUNCTIONS).
virtual size_t	get_match_ranges_count (size_t index) const =0
	Number of matched character ranges for result at index.
virtual match_range_t	get_match_range (size_t index, size_t range_idx) const =0
	Returns the range_idx'th matched range for result at index.
virtual match_range_t	get_match_line_range (size_t index) const
	For function-comment results, the range within get_name_str() that holds the matched comment line.
bool	empty () const

Detailed Description

Opaque handle owning a set of search results returned by the indexer.

The caller is responsible for deleting the object. Results are accessed by index in [0, size()).

Constructor & Destructor Documentation

~search_result_data_t()

virtual search_result_data_t::~search_result_data_t ( )

inlinevirtual

Member Function Documentation

size()

virtual size_t search_result_data_t::size ( ) const

pure virtual

Number of results.

get_name()

virtual std::string_view search_result_data_t::get_name ( size_t index ) const

pure virtual

Name of result at index.

get_name_str()

virtual const qstring & search_result_data_t::get_name_str ( size_t index ) const

pure virtual

Name of result at index, as a qstring reference.

get_score()

virtual int search_result_data_t::get_score ( size_t index ) const

pure virtual

Match score of result at index, in percent [0, 100].

get_ea()

virtual ea_t search_result_data_t::get_ea ( size_t index ) const

pure virtual

Effective address of result at index, or BADADDR for local types.

get_netnode_idx()

virtual nodeidx_t search_result_data_t::get_netnode_idx ( size_t index ) const

pure virtual

Netnode index of result at index.

get_ltype_ordinal()

virtual int search_result_data_t::get_ltype_ordinal ( size_t index ) const

pure virtual

Local type ordinal of result at index, or 0 if not a local type.

get_ltype_type()

virtual type_t search_result_data_t::get_ltype_type ( size_t index ) const

pure virtual

BT_* type code of the local type at index (valid when get_ltype_ordinal() != 0).

get_subindex()

virtual subindex_typeid_t search_result_data_t::get_subindex ( size_t index ) const

pure virtual

Sub-index that produced result at index (e.g. SUBIDX_FUNCTIONS).

get_match_ranges_count()

virtual size_t search_result_data_t::get_match_ranges_count ( size_t index ) const

pure virtual

Number of matched character ranges for result at index.

get_match_range()

virtual match_range_t search_result_data_t::get_match_range ( size_t index, size_t range_idx ) const

pure virtual

Returns the range_idx'th matched range for result at index.

get_match_line_range()

virtual match_range_t search_result_data_t::get_match_line_range ( size_t index ) const

inlinevirtual

For function-comment results, the range within get_name_str() that holds the matched comment line.

Returns {0, 0} for all other result types.

empty()

bool search_result_data_t::empty ( ) const

inline

---

The documentation for this struct was generated from the following file:

• /Users/geoffrey/ida-sdk/src/include/indexer.hpp