Logo
  • ida_auto
  • ida_bitrange
  • ida_bytes
  • ida_dbg
  • ida_dirtree
  • ida_diskio
  • ida_dscu
  • ida_entry
  • ida_expr
  • ida_fixup
  • ida_fpro
  • ida_frame
  • ida_funcs
  • ida_gdl
  • ida_graph
  • ida_hexrays
  • ida_ida
  • ida_idaapi
  • ida_idc
  • ida_idd
  • ida_idp
  • ida_ieee
  • ida_indexer
  • ida_kernwin
  • ida_libfuncs
  • ida_lines
  • ida_lumina
  • ida_loader
  • ida_merge
  • ida_mergemod
  • ida_moves
  • ida_nalt
  • ida_name
  • ida_netnode
  • ida_offset
  • ida_pro
  • ida_problems
  • ida_range
  • ida_regfinder
  • ida_registry
  • ida_search
  • ida_segment
  • ida_segregs
  • ida_srclang
  • ida_strlist
  • ida_tryblks
  • ida_typeinf
  • ida_ua
  • ida_undo
  • ida_xref
  • idaapi
  • idadex
  • idautils
  • idc
  • init
  • lumina_model
IDAPython references
  • indexer_substring_search
  • View page source

indexer_substring_search

summary: search the IDA indexer for a name (substring match)

description:

Demonstrates how to use the IDA indexer API to search for functions, named locations, local types, segments, and function comments that contain a given query string.

The indexer performs fast substring matching across all indexed data simultaneously. Each result exposes the matched name, the sub-index that produced it (e.g. SUBIDX_FUNCTIONS or SUBIDX_SEGMENTS), its score, and the effective address when applicable.

The example also shows how to narrow a search to a single sub-index when only one category of results is needed.

Note: the indexer must be enabled for the current database. Open the database with -dENABLE_INDEXER=YES to enable it, or check indexer_is_enabled() at runtime.

keywords: indexer, search, functions, names, segments, types, comments

level: beginner

Attributes

SUBIDX_NAMES

Functions

print_results(header, results)

main()

Module Contents

indexer_substring_search.SUBIDX_NAMES
indexer_substring_search.print_results(header, results)
indexer_substring_search.main()

© Copyright Hex-Rays.

Built with Sphinx using a theme provided by Read the Docs.