Topics

Here is a list of all topics with brief descriptions:

[detail level 1234]

Autoanalysis queues	Names and priorities of the analyzer queues
Status indicator states
Item end search flags	Passed as 'how' parameter to calc_max_item_end()
Flags structure	Here we define the organization of flags64_t values
States	Represent general characteristics of a byte in the program
Bits: byte states
Functions: examine byte states
Bits: specific state information
Functions: examine specific state information
Instruction/Data operands	Represent instruction/data operands
Functions: examine operand flags (specific operands)
Functions: examine operand flags (arbitrary operand)
Functions: get type information bits for flags
Functions: set operand representation
Bits: data bytes
Functions: examine data bits
Functions: manipulate data bits
Code bytes	Represent characteristics of instructions
Bits: code bytes
Functions: work with code bits
flags for get_bytes()
Unexplored byte conversion flags	Passed as 'flags' parameter to del_items()
string literal length options	Passed as 'options' parameter to get_max_strlit_length()
string conversion flags	Passed as 'flags' parameter to get_strlit_contents()
flags for use with get_strlit_type_info
Search flags	Passed as 'flags' parameter to bin_search()
Compression error codes	Returned by functions in compress.hpp
Compression methods	Passed as 'method' parameter to callback functions in compress.hpp
Option value types	Passed as 'value_type' parameter to set_options_t callbacks
Option result codes	Predefined return values for set_options_t callbacks
Option priority	Specifies the priority of a configuration option
Breakpoint modification events	Passed as 'bptev_code' parameter to dbg_bpt_changed callback
Debugger functions	Control the debugging of a process
Process commands	Use these functions to manipulate the debugged process
Debugged process states	See get_process_state(), set_process_state(), invalidate_dbg_state()
Debugged process invalidation options	See set_process_state() and invalidate_dbg_state()
Threads	Inspect/Manipulate threads of debugged process
Modules	Functions to enumerate modules loaded into the process
Execution flow control	Use these functions to run instructions in the debugged process
Registers	Inspect/Manipulate registers for debugged process
Breakpoints	Work with debugger breakpoints
Breakpoint status codes	Return values for check_bpt()
Breakpoint visitor flags	Passed as 'bvflags' parameter to bpt_visitor_t::_for_all_bpts()
Tracing	Trace instructions/functions/basic blocks
Tracing buffer	Work with debugger trace buffer
Step tracing	Plugins can use these functions to implement a custom tracing engine
Step trace options	Flags returned by get_step_trace_options()
Instruction tracing	When instruction tracing is active, each executed instruction is stored in the tracing buffer
Functions tracing	Each call to a function or return from a function is stored in the tracing buffer
Basic block tracing
Tracing events
Trace management functions
High level functions	These functions can be used from scripts
Wait for debugger event flags	Passed as 'wfne' parameter to wait_for_next_event()
Debugger options	Passed as 'options' parameter to set_debugger_options()
Source information providers	These providers supply information about the source files and lines to the source level debugger
Debugger memory functions for UI	Inspect debugged process memory
Misc	Convenience functions offered by the user interface
Breakpoint property bits	Used by bpt_t::flags
Internal breakpoint properties	Used by bpt_t::props
Source info provider property bits	Used by srcinfo_provider_t::flags
Source info changed flags	Returned by srcinfo_provider_t::get_change_flags()
bits for get_...name() methods
IDA subdirectories	Passed as 'subdir' parameter to idadir(), getsysfile(), and others
Subdirectory modification flags	Passed as 'flags' parameter to get_ida_subdirs()
Common CSIDLs	Passed as 'csidl' parameter to get_special_folder()
entry flags	Passed as 'flags' parameter to add_entry()
IDC variable slice flags	Passed as 'flags' parameter to get_idcv_slice() and set_idcv_slice()
Dereference IDC variable flags	Passed as 'vref_flags' parameter to deref_idcv()
IDC value types	Used by idc_value_t::vtype
Function description flags	Used by ext_idcfunc_t::flags
Flags for compile_idc_file()	Compile a text file with IDC function(s)
Types of fixups	Fixup may be of standard or custom type
Fixup flags	Used by fixup_data_t
Fixup handler properties	Used by fixup_handler_t::props
Tuning options
Add stkvar flags	Passed as 'flags' parameter to add_stkvar()
Register variables	Definition of regvar_t and related functions
Register variable error codes	Return values for functions in described in Register variables
Function flags	Used by func_t::flags
Function move result codes	Return values for set_func_start()
Find function bounds flags	Passed as 'flags' parameter to find_func_bounds()
Find function bounds result codes	Return values for find_func_bounds()
Error codes for signature functions:	See calc_idasgn_state() and del_idasgn()
Library function codes	Return values for try_to_add_libfunc() and apply_idasgn_to()
Flow graph building flags	Passed as flags parameter to:
Call chart building flags	Passed as flags parameter to gen_complex_call_chart()
Flow chart flags	Passed as 'flags' parameter to qflow_chart_t
Node info flags	Passed as 'flags' parameter to set_node_info()
graph_location_info_t control flags	Passed as 'flags' parameter to viewer_set_gli() and viewer_get_gli()
Proximity view layouts
Microcode error code
Number format property bits	Used in number_format_t::props
Type string related declarations	Type related functions and class
Local variable property bits	Used in lvar_t::flags
saved user lvar info property bits	Used in lvar_saved_info_t::flags
lvar_uservec_t property bits	Used in lvar_uservec_t::ulv_flags
user info bits
Bits to control how we print instructions
Well known function names
Call properties
Chain properties
chain visitor flags
instruction property bits
optimization flags
comparison bits
Basic block properties
bits for mblock_t::find_access
bits for get_valranges
Bits for optimize_local()
Bits for analyze_calls()
Batch decompilation bits
inline_func() flags
open_pseudocode flags	Used in open_pseudocode
Batch decompilation bits
Expression attributes	Used in cexpr_t::exflags
Ctree visitor property bits	Used in ctree_visitor_t::cv_flags
get_label_num control
ctree item iflags bits
cfunc state bits
decompile() flags
User interface definitions
Properties of pseudocode window	Used in vdui_t::flags
General idainfo flags	Used by idainfo::s_genflags
Misc. database flags	Used by idainfo::lflags
IDB pack modes	Used by idainfo::get_pack_mode
Analysis flags	Used by idainfo::af
Analysis flags 2	Used by idainfo::af2
Xref options	Used by idainfo::s_xrefflag
Dummy names representation types	Used by idainfo::nametype
Demangled name flags	Used by idainfo::demnames
Name list options	Used by idainfo::listnames
output flags	Used by idainfo::outflags
Comment options	Used by idainfo::s_cmtflg
Delimiter options	Used by idainfo::s_limiter
Line prefix options	Used by idainfo::s_prefflag
string literal flags	Used by idainfo::strlit_flags
abi options	Used by idainfo::abibits
flags used by validate_idb()
Register info attribute flags	Used by register_info_t::flags
Hardware breakpoint ids	Fire the breakpoint upon one of these events
Exception info flags	Used by exception_info_t::flags
Register value types	Used by regval_t::rvtype
Debugger API module id	Used by debugger_t::id
Debugger module features	Debugger module features may be set inside debugger_t::init_debugger() except of the severals
Resume modes	Used by debugger_t::resume_modes
Debug process flags	Passed as 'dbg_proc_flags' parameter to debugger_t::start_process
Breakpoint verification codes	Return values for debugger_t::check_bpt
Appcall options	Passed as 'options' parameter to debugger_t::appcall
Instruction feature bits	Used by instruc_t::feature
Assembler feature bits	Used by asm_t::flag
Secondary assembler feature bits	Used by asm_t::flag2
Hook installation bits.
Processor IDs	Used by processor_t::id
Processor feature bits	Used by processor_t::flag
Processor additional feature bits	Used by processor_t::flag2
SP/FP operand flags	Return values for processor_t::is_sp_based()
Floating point/IEEE Conversion codes	Return values for ieee_realcvt and processor_t::realcvt request
Set menu flags	Passed as 'flags' parameter to attach_action_to_menu() In case menupath == nullptr new item will be added to the end of menu even when SETMENU_APP is not set
create toolbar flags	Passed as 'flags' parameter to create_toolbar()
set_highlight flags	Passed as 'flags' parameter to set_highlight()
Code viewer flags	Passed as 'flags' parameter to create_code_viewer()
IDC hotkey error codes	Return values for add_idc_hotkey()
Form close flags	Passed as options to close_widget()
Docking positions	Passed as 'orient' parameter to set_dock_pos()
Source viewer creation flags	Passed as 'flags' parameter to callback for ui_create_source_viewer
Custom viewer navigation flags	Passed as 'flags' parameter to custom_viewer_jump()
Widget open flags	Passed as options to open_form() and display_widget()
Dialogs for "Rename address"
Custom viewer location-retrieving flags	Passed as 'flags' parameter to get_custom_viewer_location()
Simpleline interface	IDA custom viewer sample
keys	Passed as 'bg_color' of a line_rendering_output_entry_t, to use a CSS property of the widget ('qproperty-line-bgovl-extra-N') instead of a direct color
line_rendering_output_entry_t flags	Used by 'flags' of a line_rendering_output_entry_t
Window types	Also see Functions: open built-in windows
Window refresh flags	Passed as 'mask' parameter to request_refresh()
IDA debug bits	Used by debug
Generic chooser flags	Used as 'chooser_base_t::flags'
Extended chooser flags	Used as 'chooser_base_t::flags2'
Chooser column flags	Used by 'widths' parameter for Functions: generic list choosers
Chooser item property bits	Used by chooser_item_attrs_t::flags
Flags for get_chooser_rows().
Special values of the chooser index	Used in the following contexts:
Text control property bits	Used by textctrl_info_t::flags
Functions: generic list choosers	These functions display a window that allows the user to select items
CLI attributes	Used by cli_t::flags
Exec request flags	Passed as 'reqf' parameter to execute_sync()
Jump flags	Passed as 'uijmp_flags' parameter to jumpto()
Action context property bits	Used by action_ctx_base_t::cur_flags
Action flags	Used by register_action()
Functions: update actions	Convenience functions for ui_update_action_attr
Functions: get action attributes	Convenience functions for ui_get_action_attr
Functions: custom viewer handlers	Convenience functions for ui_set_custom_viewer_handler
Functions: open built-in windows	Convenience functions for ui_open_builtin
Functions: built-in choosers	Convenience functions for ui_choose and choose_type_t
ask_form()/open_form()	This module describes how to generate a custom form
Button IDs	Used by ask_yn() and ask_buttons()
Input line history constants	Passed as 'hist' parameter to ask_str()
Functions: add-ons	Convenience functions for ui_addons
Functions: strings	Functions that manipulate strings
line cleanup flags	Passed as 'flags' parameter to qcleanline()
Functions: string conversion	Functions that convert between string encodings
String to address conversion flags	Passed as 'flags' parameter to str2ea_ex()
Compatibility Windows virtual keys	Compatibility windows virtual keys to use in plugins which are not Qt aware
Form callback special values
Parser token types	See token_t::type
Lexer options	Passed as 'options' parameter to lex_set_options()
Color definitions	Here we describe the structure of embedded escape sequences used to implement syntax highlighting
Color escape characters	Initiate/Terminate a color tag
Color tags	Specify a color for a syntax item
Color string constants	These definitions are used with the #COLSTR macro
Line prefix colors	Note: line prefix colors are not used in processor modules
Convenience functions	Higher level convenience functions are defined in ua.hpp
Loader flags	Used by loader_t::flags
Load file flags	Passed as 'neflags' parameter to loader_t::load_file
loader info flags	Used by load_info_t::lflags
Generate file flags	Passed as 'flags' parameter to gen_file()
Plugin features	Used by plugin_t::flags
Plugin initialization codes	Return values for plugin_t::init() Deprecated, please update your plugins to use PLUGIN_MULTI
Snapshot flags	Used by snapshot_t::flags
Snapshot update flags	Passed as 'uf' parameter to update_snapshot_attributes()
Database flags	Used to manage saving/closing of a database
Types of the file pathes
Structure of altvals array	Structure of altvals array of netnode(ea)
Structure of supvals array	Structure of supvals array of netnode(ea)
Netnode xref tags	Tag values to store xrefs (see cref.cpp)
Netnode graph tags	Tag values to store graph info
UI desktops
Additional flags for the location	All 32-bits of the main flags (bytes.hpp) are used up
String type codes
Switch info flags	Used by switch_info_t::flags
Types of references	References are represented in the following form:
Reference info flags	Used by refinfo_t::flags
Refinfo handler properties	Used by custom_refinfo_handler_t::props
Rootnode indexes:
Set name flags	Passed as 'flag' parameter to set_name(ea_t, const char *, int)
Name value result codes	Return values for get_name_value()
bits for get_ea_name() function. There is a convenience	Function calc_gtn_flags() to calculate the GN_LOCAL flag
Name expression flags	Passed as 'flags' parameter to get_name_expr()
Nice colored name flags	Passed as 'flags' parameter to get_nice_colored_name()
Reserved netnode tags	Tags internally used in netnodes
Functions to test ASCII char attributes	The is...() functions in ctype.h will misbehave with 'char' argument
qsnprintf/qsscanf	Safer versions of sprintf/sscanf
Pack/Unpack	Functions for packing and unpacking values
Template unpacking	Template functions that can unpack values
Flags for _qstring::split
Relocatable object info flags	Used by relobj_t::ri
Functions: c strings	String C-style conversions (convert \n to a newline and vice versa)
IDB default encoding -> UTF-8 encoding flags	Used by idb_utf8
Convert encoding flags	Used by convert_encoding
i/o redirection flags	Used by channel_redir_t::flags
Launch process flags	Used by launch_process_params_t::flags
Search flags
Segments	Functions that deal with segments.
Segment structure	Definition of segment_t and related functions
Segment alignment codes	Used by segment_t::align
Segment combination codes	Used by segment_t::comb
Segment permissions	Used by segment_t::perm
Segment flags	Used by segment_t::flags
Segment types	Used by segment_t::type
Segment selectors	The kernel maintains a table to translate selector values to segment base paragraphs
Segment manipulation functions	Add/Delete/Modify segments
Add segment flags	Passed as 'flags' parameter to add_segm_ex()
Segment modification flags	Used by functions in Segment manipulation functions
Move segment result codes	Return values for move_segm() add rebase_program()
Move segment flags	Passed as 'flags' parameter to move_segm() and rebase_program()
Change segment status result codes	Return values for change_segment_status()
Snapshot types	Specifies which segments should be included in the snapshot
Segment groups
Segment translations	Used to represent overlayed memory banks
Segment comments	Segment comments are rarely used yet
Segment names	Various ways to retrieve the name of a segment
Segment classes and types	See Segment types
Segment alignment and combination
Segment addressing
Segment register range tags	Used by sreg_range_t::tag
Source language IDs
Try block handling error codes
flags for is_ea_tryblks()
Type flags	Here we describe the byte arrays used to describe type information
Masks
Basic type: unknown & void
Basic type: integer
Basic type: bool
Basic type: float
Basic type: last
Derived type: pointer
Derived type: array
Derived type: function
Function attribute byte
Derived type: complex
Type modifiers
Special enum definitions
Convenience definitions: segment register
Convenience definitions: unknown types
Convenience definitions: shortcuts
Type attributes
Extended type attributes
Type attributes for udts
Type attributes for udt fields
Type attributes for pointers
Type attributes for enums
Nontrivial types
Type info library property bits	Used by til_t::flags
Add TIL result codes	Returned by add_base_tils()
CM	Calling convention & Model
Default pointer size
Model
Calling convention
Argument locations
Standard C-language models for x86
Argument location types
Standard C-language models for x86
CC	Target compiler
Compiler IDs
Functions: work with compiler IDs
Set compiler flags
Type parsing	Format/Parse/Print type information
Type formatting flags
Type parsing flags
Type printing flags
Named types	Functions to work with named types
Flags for named types
C/C++ naming flags
Numbered types	Functions to work with numbered (ordinal) types
Link between vftable types and addresses
Load TIL flags	Passed as 'flags' parameter to add_til()
Load TIL result codes	Return values for add_til()
Apply tinfo flags	Passed as 'flags' parameter to apply_tinfo()
Guess tinfo codes	Return values for guess_tinfo()
type changing flags	Constants to be used the editing methods
UDT serialization flags	Passed as 'sudt_flags' parameter of helpers declared in #DECLARE_TINFO_HELPERS
Find UDT member flags	Used by 'strmem_flags' parameter to find_udm()
tinfo_t comparison flags	Passed as 'tcflags' parameter to tinfo_t::compare_with()
Function argument property bits	Used by funcarg_t::flags
Function type data property bits	Used by func_type_data_t::flags
Type modification bits	Used by type_mods_t::flags
tinfo visitor states	Used by tinfo_visitor_t::state
Local types information and manipulation helpers
C data formatting properties	C data formatting properties
print_decls() flags
Operands	Work with instruction operands
Operand types	Various types of instruction operands
Operand structure	Definition of op_t and related items
Operand flags	Used by op_t::flags
Operand value types	Used by op_t::dtype
Instruction	Definition of ::insn_t and related items
Operand shortcuts
Instruction flags
Stack variable flags
Output value flags	Flags passed to out_value()
format flags	Used by format_charlit
Cross-Reference types	Describe categories of code/data xrefs
Cross-Reference type flags	These flags are combined with a cref_t or dref_t value to describe the type of a cross reference
Xref enumeration flags	Passed as 'flags' parameter to functions in xrefblk_t