IDAPython API Reference

https://python.docs.hex-rays.com/
Admin
IDAPython allows users to create custom scripts and plugins to enhance IDA's core functionality,...
Tokens:2,029,948
Snippets:20,641
Trust Score:10
Update:16 hours ago
Show doc for...
Tokens:
Raw
### start_process

Source: https://python.docs.hex-rays.com/ida_idd/index.html

Starts a process with the specified path, arguments, environment, start directory, debugger process flags, input path, and input file CRC32. Returns an error string on failure or None on success.

```APIDOC
## start_process

### Description
Starts a process with the given parameters.

### Method
start_process

### Parameters
- **path** (str) - Required - The path to the executable.
- **args** (str) - Required - The command-line arguments.
- **envs** (launch_env_t) - Required - The environment variables.
- **startdir** (str) - Required - The starting directory.
- **dbg_proc_flags** (int) - Required - Debugger process flags.
- **input_path** (str) - Required - The input file path.
- **input_file_crc32** (int) - Required - The CRC32 of the input file.

### Returns
- **str | None** - Error message on failure, or None on success.
```

--------------------------------

### start

Source: https://python.docs.hex-rays.com/ida_netnode/index.html

Starts iteration over netnodes. Returns a boolean indicating success.

```APIDOC
## start

### Description
Starts iteration over netnodes.

### Method
Function

### Signature
start() → bool

### Parameters
None.

### Returns
- **bool** - True if iteration started successfully, False otherwise.
```

--------------------------------

### start_process

Source: https://python.docs.hex-rays.com/ida_dbg/index.html

Starts a process in the debugger. Returns -1 if impossible to create the process, 0 if cancelled by the user, 1 if properly started.

```APIDOC
## start_process

### Description
Starts a process in the debugger. Returns -1 if impossible to create the process, 0 if cancelled by the user, 1 if properly started.

### Function
`ida_dbg.start_process(path: str = None, args: str = None, sdir: str = None) -> int`

### Parameters
- **path** (str) - Optional - Path to the executable to start.
- **args** (str) - Optional - Arguments to pass to the process.
- **sdir** (str) - Optional - Starting directory for the process.

### Returns
- **int** - -1: impossible to create the process; 0: starting cancelled by the user; 1: process properly started.

### Notes
- Asynchronous function - available as Request, Notification, dbg_process_start.
```

--------------------------------

### inf_get_start_ea

Source: https://python.docs.hex-rays.com/ida_ida/index.html

Gets the start effective address. Returns an ea_t value.

```APIDOC
## inf_get_start_ea

### Description
Gets the start effective address from the IDA database.

### Function Signature
`inf_get_start_ea() -> ida_idaapi.ea_t`

### Parameters
None

### Return Value
- **ida_idaapi.ea_t** - The start effective address.
```

--------------------------------

### start_process

Source: https://python.docs.hex-rays.com/ida_dbg/index.html

Starts a process in the debugger.

```APIDOC
## start_process

### Description
Start a process in the debugger.

### Signature
`start_process() -> int`

### Return Value
- **int** - Status code.

### Notes
- Asynchronous function - available as Request, Notification, dbg_process_start.
```

--------------------------------

### idautils.Heads([start, end])

Source: https://python.docs.hex-rays.com/idautils/index.html

Get a list of heads (instructions or data items).

```APIDOC
## idautils.Heads([start, end])

### Description
Get a list of heads (instructions or data items).

### Parameters
- **start** (int) - Optional - Start address.
- **end** (int) - Optional - End address.

### Returns
List of heads.
```

--------------------------------

### ida_bytes.prev_head(ea, minea)

Source: https://python.docs.hex-rays.com/ida_bytes/index.html

Gets the start of the previous defined item. Returns BADADDR if none exists.

```APIDOC
## ida_bytes.prev_head(ea, minea)

### Description
Get start of previous defined item.

### Signature
`ida_bytes.prev_head(ea: ida_idaapi.ea_t, minea: ida_idaapi.ea_t) -> ida_idaapi.ea_t`

### Parameters
- **ea** (ida_idaapi.ea_t) - Required - Begin search at this address.
- **minea** (ida_idaapi.ea_t) - Required - Included in the search range.

### Returns
- **ida_idaapi.ea_t** - Start of previous defined item, or BADADDR if none exists.
```

--------------------------------

### get_segment_ea

Source: https://python.docs.hex-rays.com/ida_segment/index.html

Get segment start address.

```APIDOC
## get_segment_ea

### Description
Get segment start address.

### Returns
- **ida_idaapi.ea_t** - The segment start address.
```

--------------------------------

### optinsn_t.install()

Source: https://python.docs.hex-rays.com/ida_hexrays/index.html

Installs the optimization callback.

```APIDOC
## optinsn_t.install()

### Description
Install the optimization callback.

### Signature
```python
def install(self) -> None
```

### Returns
- **None**
```

--------------------------------

### ev_setup_til

Source: https://python.docs.hex-rays.com/ida_idp/index.html

Sets up default type libraries. Called after loading a new file into the database. The processor module may load tils, setup memory model, and perform other actions required to set up the type system. This is an optional callback.

```APIDOC
## ev_setup_til

### Description
Setup default type libraries. (called after loading a new file into the database). The processor module may load tils, setup memory model and perform other actions required to set up the type system. This is an optional callback.

### Returns
- void
```

--------------------------------

### addon_count

Source: https://python.docs.hex-rays.com/ida_kernwin/index.html

Gets the number of installed addons.

```APIDOC
## addon_count

### Description
Get number of installed addons.

### Returns
int
```

--------------------------------

### start_process(path, args, sdir)

Source: https://python.docs.hex-rays.com/ida_dbg/index.html

Starts a process for debugging. This function is not fully documented in the source.

```APIDOC
## start_process(path, args, sdir)

### Description
Starts a process for debugging.

### Method
Synchronous function

### Parameters
- **path** (str) - Optional - Path to the executable.
- **args** (str) - Optional - Command-line arguments.
- **sdir** (str) - Optional - Working directory.

### Returns
- **int** - Result code (not documented).

```

--------------------------------

### read_selection_start()

Source: https://python.docs.hex-rays.com/idc/index.html

Gets the start address of the selected range.

```APIDOC
## read_selection_start()

### Description
Get start address of the selected range.

### Returns
Start address of the selection, or BADADDR if no selection.
```

--------------------------------

### get_segment_ea_by_name

Source: https://python.docs.hex-rays.com/ida_segment/index.html

Get segment start address by its name.

```APIDOC
## get_segment_ea_by_name

### Description
Get segment start address by its name. If there are several segments with the same name, returns the first of them.

### Signature
`ida_segment.get_segment_ea_by_name(name: str) -> ida_idaapi.ea_t`

### Parameters
- **name** (str) - Required - Segment name (may be nullptr)

### Returns
segment start_ea, or BADADDR if not found.
```

--------------------------------

### get_last_segment_ea

Source: https://python.docs.hex-rays.com/ida_segment/index.html

Get start address of the last segment.

```APIDOC
## get_last_segment_ea

### Description
Get start address of the last segment.

### Signature
`ida_segment.get_last_segment_ea() -> ida_idaapi.ea_t`

### Returns
segment start_ea, or BADADDR if no segments exist.
```

--------------------------------

### apply_startup_sig(ea, startup)

Source: https://python.docs.hex-rays.com/ida_funcs/index.html

Applies a startup signature file to the specified address.

```APIDOC
## apply_startup_sig(ea, startup)

### Description
Applies a startup signature file to the specified address.

### Parameters
- **ea** (ida_idaapi.ea_t) - Required - Address to apply the signature to; usually idainfo::start_ea
- **startup** (str) - Required - The name of the signature file without path and extension

### Returns
- **bool** - True if successfully applied the signature

```

--------------------------------

### optblock_t.install()

Source: https://python.docs.hex-rays.com/ida_hexrays/index.html

Installs the block optimization callback.

```APIDOC
## optblock_t.install()

### Description
Install the block optimization callback.

### Signature
```python
def install(self) -> None
```

### Returns
- **None**
```

--------------------------------

### get_first_segment_ea

Source: https://python.docs.hex-rays.com/ida_segment/index.html

Get start address of the first segment.

```APIDOC
## get_first_segment_ea

### Description
Get start address of the first segment. The returned address can be used as a handle for other segment_* functions.

### Signature
`ida_segment.get_first_segment_ea() -> ida_idaapi.ea_t`

### Returns
segment start_ea, or BADADDR if no segments exist.
```

--------------------------------

### request_start_process

Source: https://python.docs.hex-rays.com/ida_dbg/index.html

Posts a start_process() request.

```APIDOC
## request_start_process

### Description
Posts a start_process() request.

### Function
`ida_dbg.request_start_process(path: str = None, args: str = None, sdir: str = None) -> int`

### Parameters
- **path** (str) - Optional - Path to the executable to start.
- **args** (str) - Optional - Arguments to pass to the process.
- **sdir** (str) - Optional - Starting directory for the process.

### Returns
- **int** - Result of the request.
```

--------------------------------

### get_prev_segment_ea

Source: https://python.docs.hex-rays.com/ida_segment/index.html

Get start address of the previous segment.

```APIDOC
## get_prev_segment_ea

### Description
Get start address of the previous segment.

### Signature
`ida_segment.get_prev_segment_ea(seg_ea: ida_idaapi.ea_t) -> ida_idaapi.ea_t`

### Parameters
- **seg_ea** (ida_idaapi.ea_t) - Required - Linear address belonging to the segment

### Returns
start_ea of previous segment, or BADADDR if no more segments.
```

--------------------------------

### get_next_segment_ea

Source: https://python.docs.hex-rays.com/ida_segment/index.html

Get start address of the next segment.

```APIDOC
## get_next_segment_ea

### Description
Get start address of the next segment.

### Signature
`ida_segment.get_next_segment_ea(seg_ea: ida_idaapi.ea_t) -> ida_idaapi.ea_t`

### Parameters
- **seg_ea** (ida_idaapi.ea_t) - Required - Linear address belonging to the segment

### Returns
start_ea of next segment, or BADADDR if no more segments.
```

--------------------------------

### request_start_process

Source: https://python.docs.hex-rays.com/ida_dbg/index.html

Posts a start_process() request.

```APIDOC
## request_start_process

### Description
Post a start_process() request.

### Signature
`request_start_process() -> int`

### Return Value
- **int** - Status code.
```

--------------------------------

### udc_filter_t.install

Source: https://python.docs.hex-rays.com/ida_hexrays/index.html

Installs the filter.

```APIDOC
## udc_filter_t.install

### Description
Installs the filter.

### Method
install()

### Signature
install() -> None

### Parameters
None

### Returns
None
```

--------------------------------

### Choose.OnInit

Source: https://python.docs.hex-rays.com/ida_kernwin/index.html

Initialize the chooser and populate it. This callback is optional.

```APIDOC
## Choose.OnInit

### Description
Initialize the chooser and populate it. This callback is optional.

### Method
OnInit

### Parameters
None

### Returns
None
```

--------------------------------

### get_prev_segment_ea

Source: https://python.docs.hex-rays.com/ida_segment/index.html

Get start address of the previous segment.

```APIDOC
## get_prev_segment_ea

### Description
Get start address of the previous segment.

### Returns
- **ida_idaapi.ea_t** - The start address of the previous segment.
```

--------------------------------

### get_next_segment_ea

Source: https://python.docs.hex-rays.com/ida_segment/index.html

Get start address of the next segment.

```APIDOC
## get_next_segment_ea

### Description
Get start address of the next segment.

### Returns
- **ida_idaapi.ea_t** - The start address of the next segment.
```

--------------------------------

### for_all_topinsns

Source: https://python.docs.hex-rays.com/ida_hexrays/index.html

Visits all top level instructions using a visitor object.

```APIDOC
## for_all_topinsns

### Description
Visits all top level instructions.

### Method
for_all_topinsns

### Signature
for_all_topinsns(_mv: minsn_visitor_t_) → int

### Parameters
- **mv** (minsn_visitor_t) - Required - The instruction visitor.

### Returns
- **int** - Non-zero value returned by mv.visit_mop() or zero.
```

--------------------------------

### idautils.Chunks(start)

Source: https://python.docs.hex-rays.com/idautils/index.html

Get a list of function chunks.

```APIDOC
## idautils.Chunks(start)

### Description
Get a list of function chunks.

### Parameters
- **start** (int) - Required - Start address of the function.

### Returns
List of function chunks.
```

--------------------------------

### install_hexrays_callback(callback)

Source: https://python.docs.hex-rays.com/ida_hexrays/index.html

Installs a handler for decompiler events.

```APIDOC
## install_hexrays_callback(callback)

### Description
Installs a handler for decompiler events.

### Method
Function

### Signature
install_hexrays_callback(callback)

### Parameters
- **callback** - The callback function to install.

### Returns
None.
```

--------------------------------

### idautils.Functions([start, end])

Source: https://python.docs.hex-rays.com/idautils/index.html

Get a list of functions.

```APIDOC
## idautils.Functions([start, end])

### Description
Get a list of functions.

### Parameters
- **start** (int) - Optional - Start address.
- **end** (int) - Optional - End address.

### Returns
List of functions.
```

--------------------------------

### apply_startup_sig

Source: https://python.docs.hex-rays.com/ida_funcs/index.html

Applies a startup signature file to the specified address.

```APIDOC
## apply_startup_sig

### Description
Applies a startup signature file to the specified address.

### Return Type
bool

```

--------------------------------

### ida_bytes.get_item_head

Source: https://python.docs.hex-rays.com/ida_bytes/index.html

Get the start address of the item at 'ea'.

```APIDOC
## get_item_head(ea)

### Description
Get the start address of the item at 'ea'. If there is no current item, then 'ea' is returned.

### Parameters
- **ea** (ea_t) - Required - The address of the item.

### Returns
- **ea_t** - The start address of the item.
```

--------------------------------

### ida_bytes.next_head

Source: https://python.docs.hex-rays.com/ida_bytes/index.html

Get start of next defined item.

```APIDOC
## next_head(ea, maxea)

### Description
Get start of next defined item.

### Parameters
- **ea** (ea_t) - Required - Begin search at this address.
- **maxea** (ea_t) - Required - Not included in the search range.

### Returns
- **ea_t** - BADADDR if none exists.
```

--------------------------------

### install_user_defined_prefix

Source: https://python.docs.hex-rays.com/ida_lines/index.html

Installs a user-defined prefix callback. Accepts variable arguments and returns a boolean.

```APIDOC
## install_user_defined_prefix

### Description
Installs a user-defined prefix callback.

### Method
Function

### Signature
`ida_lines.install_user_defined_prefix(*args) -> bool`

### Parameters
- **\*args** - Variable arguments (implementation-specific).

### Returns
- **bool** - True on success, False on failure.
```

--------------------------------

### for_all_insns

Source: https://python.docs.hex-rays.com/ida_hexrays/index.html

Visits all instructions and subinstructions using a visitor object.

```APIDOC
## for_all_insns

### Description
Visits all instructions and subinstructions.

### Method
for_all_insns

### Signature
for_all_insns(_mv: minsn_visitor_t_) → int

### Parameters
- **mv** (minsn_visitor_t) - Required - The instruction visitor.

### Returns
- **int** - Non-zero value returned by mv.visit_mop() or zero.
```

--------------------------------

### next_head

Source: https://python.docs.hex-rays.com/ida_bytes/index.html

Gets the start of the next defined item.

```APIDOC
## next_head

### Description
Gets the start of the next defined item.

### Method
Function

### Endpoint
ida_bytes.next_head

### Parameters
No parameters documented.

### Returns
- ida_idaapi.ea_t
```

--------------------------------

### hx_install_optinsn_handler

Source: https://python.docs.hex-rays.com/ida_hexrays/index.html

Installs an optimization instruction handler.

```APIDOC
## hx_install_optinsn_handler

### Description
Installs an optimization instruction handler.

### Method
Function

### Signature
`hx_install_optinsn_handler()`

### Parameters
None

### Returns
None
```

--------------------------------

### prev_head

Source: https://python.docs.hex-rays.com/ida_bytes/index.html

Gets the start of the previous defined item.

```APIDOC
## prev_head

### Description
Gets the start of the previous defined item.

### Method
Function

### Endpoint
ida_bytes.prev_head

### Parameters
No parameters documented.

### Returns
- ida_idaapi.ea_t
```

--------------------------------

### hx_install_hexrays_callback

Source: https://python.docs.hex-rays.com/ida_hexrays/index.html

Installs a Hex-Rays callback.

```APIDOC
## hx_install_hexrays_callback

### Description
Installs a Hex-Rays callback.

### Method
N/A (Python function)

### Endpoint
N/A

### Parameters
- **callback** (callable) - Required - The callback function.

### Returns
- **bool** - True on success, False on failure.

```

--------------------------------

### frame_off_args_ea

Source: https://python.docs.hex-rays.com/ida_frame/index.html

Get starting address of arguments section.

```APIDOC
## frame_off_args_ea

### Description
Get starting address of arguments section.

### Returns
ida_idaapi.ea_t
```

--------------------------------

### begin()

Source: https://python.docs.hex-rays.com/ida_dscu/index.html

Returns an iterator to the beginning of the vector.

```APIDOC
## begin()

### Description
Returns an iterator to the beginning of the vector.

### Returns
- **qvector< string_match_t >::const_iterator** - Iterator to the first element.

```

--------------------------------

### get_prev_hidden_range_ea

Source: https://python.docs.hex-rays.com/ida_bytes/index.html

Get start address of the previous hidden range.

```APIDOC
## get_prev_hidden_range_ea

### Description
Get start address of the previous hidden range.

### Method
Function call

### Endpoint
ida_bytes.get_prev_hidden_range_ea()

### Parameters
No parameters documented.

### Return Value
- **ida_idaapi.ea_t** - Start address of the previous hidden range.
```

--------------------------------

### get_next_hidden_range_ea

Source: https://python.docs.hex-rays.com/ida_bytes/index.html

Get start address of the next hidden range.

```APIDOC
## get_next_hidden_range_ea

### Description
Get start address of the next hidden range.

### Method
Function call

### Endpoint
ida_bytes.get_next_hidden_range_ea()

### Parameters
No parameters documented.

### Return Value
- **ida_idaapi.ea_t** - Start address of the next hidden range.
```

--------------------------------

### init.IDAPythonHelpPrompter

Source: https://python.docs.hex-rays.com/init/index.html

Help prompter class with a readline method.

```APIDOC
## class init.IDAPythonHelpPrompter

### Description
Help prompter class.

### Methods
#### readline()
Reads a line from the prompter.
```

--------------------------------

### get_last_hidden_range_ea

Source: https://python.docs.hex-rays.com/ida_bytes/index.html

Get start address of the last hidden range.

```APIDOC
## get_last_hidden_range_ea

### Description
Get start address of the last hidden range.

### Method
Function call

### Endpoint
ida_bytes.get_last_hidden_range_ea()

### Parameters
No parameters documented.

### Return Value
- **ida_idaapi.ea_t** - Start address of the last hidden range.
```

--------------------------------

### get_first_hidden_range_ea

Source: https://python.docs.hex-rays.com/ida_bytes/index.html

Get start address of the first hidden range.

```APIDOC
## get_first_hidden_range_ea

### Description
Get start address of the first hidden range.

### Method
Function call

### Endpoint
ida_bytes.get_first_hidden_range_ea()

### Parameters
No parameters documented.

### Return Value
- **ida_idaapi.ea_t** - Start address of the first hidden range.
```

--------------------------------

### setup_selector

Source: https://python.docs.hex-rays.com/ida_segment/index.html

Allocates a selector for a segment if necessary.

```APIDOC
## setup_selector

### Description
Allocates a selector for a segment if necessary. Must be called before add_segm_ex(). add_segm() calls this function itself.

### Method
Function

### Signature
`ida_segment.setup_selector(segbase: ida_idaapi.ea_t) -> sel_t`

### Parameters
- **segbase** (ida_idaapi.ea_t) - Required - A new segment base paragraph.

### Returns
- **sel_t** - The allocated selector number.
```

--------------------------------

### for_all_insns(mv) -> int

Source: https://python.docs.hex-rays.com/ida_hexrays/index.html

Visits all instructions in the block, including subinstructions.

```APIDOC
## for_all_insns(mv) -> int

### Description
Visit all instructions. This function visits subinstructions too.

### Parameters
- **mv** (minsn_visitor_t) - Required - Instruction visitor.

### Returns
- Zero or the value returned by mv.visit_insn(). See also mba_t::for_all_topinsns().
```

--------------------------------

### frame_off_args_ea

Source: https://python.docs.hex-rays.com/ida_frame/index.html

Gets the starting address of the arguments section in the frame.

```APIDOC
## frame_off_args_ea

### Description
Get starting address of arguments section

### Signature
`frame_off_args_ea(func_ea: ida_idaapi.ea_t) -> ida_idaapi.ea_t`

### Parameters
- **func_ea** (ida_idaapi.ea_t) - Required - any address of the function

### Returns
- **ida_idaapi.ea_t** - offset in frame or BADADDR on failure
```

--------------------------------

### frame_off_lvars_ea

Source: https://python.docs.hex-rays.com/ida_frame/index.html

Get start address of local variables section.

```APIDOC
## frame_off_lvars_ea

### Description
Get start address of local variables section.

### Returns
ida_idaapi.ea_t
```

--------------------------------

### DBG_Hooks.dbg_started_loading_bpts

Source: https://python.docs.hex-rays.com/ida_dbg/index.html

Callback for when breakpoint loading starts.

```APIDOC
## DBG_Hooks.dbg_started_loading_bpts

### Description
Called when the debugger starts loading breakpoints.

### Method
`dbg_started_loading_bpts() -> None`

### Parameters
None.
```

--------------------------------

### frame_off_savregs_ea

Source: https://python.docs.hex-rays.com/ida_frame/index.html

Get starting address of saved registers section.

```APIDOC
## frame_off_savregs_ea

### Description
Get starting address of saved registers section.

### Returns
ida_idaapi.ea_t
```

--------------------------------

### apply_idasgn_to(signame, ea, is_startup)

Source: https://python.docs.hex-rays.com/ida_funcs/index.html

Applies a signature file to the specified address.

```APIDOC
## apply_idasgn_to(signame, ea, is_startup)

### Description
Apply a signature file to the specified address.

### Parameters
- **signame** (str) - Required - Short name of signature file (the file name without path)
- **ea** (ea_t) - Required - Address to apply the signature
- **is_startup** (bool) - Required - If set, then the signature is treated as a startup one for startup signature ida doesn't rename the first function of the applied module.

### Returns
- **int** - Library function codes
```

--------------------------------

### frame_off_retaddr_ea

Source: https://python.docs.hex-rays.com/ida_frame/index.html

Get starting address of return address section.

```APIDOC
## frame_off_retaddr_ea

### Description
Get starting address of return address section.

### Returns
ida_idaapi.ea_t
```

--------------------------------

### init.print_banner()

Source: https://python.docs.hex-rays.com/init/index.html

Prints the banner.

```APIDOC
## init.print_banner()

### Description
Prints the banner.
```

--------------------------------

### chunk_start

Source: https://python.docs.hex-rays.com/ida_bytes/index.html

Gets the start of the contiguous address block containing 'ea'.

```APIDOC
## chunk_start

### Description
Gets the start of the contiguous address block containing 'ea'.

### Method
Function

### Endpoint
ida_bytes.chunk_start

### Parameters
No parameters documented.

### Returns
- ida_idaapi.ea_t
```

--------------------------------

### pyscv_init

Source: https://python.docs.hex-rays.com/ida_kernwin/index.html

Initializes a simple chooser view.

```APIDOC
## pyscv_init

### Description
Initializes a simple chooser view.

### Method
Function call

### Signature
pyscv_init()

### Returns
- PyObject* - Initialization result.
```

--------------------------------

### Choose.OnLazyLoadDir (Deprecated)

Source: https://python.docs.hex-rays.com/ida_kernwin/index.html

Deprecated callback.

```APIDOC
## Choose.OnLazyLoadDir (Deprecated)

### Description
Deprecated callback.

### Method
OnLazyLoadDir

### Parameters
- **path** - The path to load.
```

--------------------------------

### inf_get_start_ip

Source: https://python.docs.hex-rays.com/ida_ida/index.html

Gets the start instruction pointer. Returns an ea_t value.

```APIDOC
## inf_get_start_ip

### Description
Gets the start instruction pointer from the IDA database.

### Function Signature
`inf_get_start_ip() -> ida_idaapi.ea_t`

### Parameters
None

### Return Value
- **ida_idaapi.ea_t** - The start instruction pointer.
```

--------------------------------

### init.IDAPythonHelp

Source: https://python.docs.hex-rays.com/init/index.html

Help class derived from pydoc.Helper, providing a help method.

```APIDOC
## class init.IDAPythonHelp

### Description
Help class derived from pydoc.Helper.

### Methods
#### help(*args)
Displays help information.
```

--------------------------------

### inf_get_start_cs

Source: https://python.docs.hex-rays.com/ida_ida/index.html

Gets the start code segment. Returns a sel_t value.

```APIDOC
## inf_get_start_cs

### Description
Gets the start code segment from the IDA database.

### Function Signature
`inf_get_start_cs() -> sel_t`

### Parameters
None

### Return Value
- **sel_t** - The start code segment selector.
```

--------------------------------

### inf_get_start_ss

Source: https://python.docs.hex-rays.com/ida_ida/index.html

Gets the start stack segment. Returns a sel_t value.

```APIDOC
## inf_get_start_ss

### Description
Gets the start stack segment from the IDA database.

### Function Signature
`inf_get_start_ss() -> sel_t`

### Parameters
None

### Return Value
- **sel_t** - The start stack segment selector.
```

--------------------------------

### install_command_interpreter

Source: https://python.docs.hex-rays.com/ida_kernwin/index.html

Installs a command line interpreter (ui_install_cli).

```APIDOC
## install_command_interpreter

### Description
Installs a command line interpreter (ui_install_cli).

### Method
Function call

### Signature
install_command_interpreter()

### Returns
- int - Status code.
```

--------------------------------

### ida_frame.frame_off_args

Source: https://python.docs.hex-rays.com/ida_frame/index.html

Gets the starting address of the arguments section of a function frame.

```APIDOC
## frame_off_args(pfn)

### Description
Get starting address of arguments section.

### Parameters
- **pfn** (func_t const *) - Required - pointer to function

### Returns
- starting address of arguments section
```

--------------------------------

### launch_env_t

Source: https://python.docs.hex-rays.com/ida_idd/index.html

Environment for launching a process.

```APIDOC
## launch_env_t

### Description
Environment for launching a process.

### Type
Class

### Module
ida_idd
```

--------------------------------

### frame_off_savregs_ea

Source: https://python.docs.hex-rays.com/ida_frame/index.html

Gets the starting address of the saved registers section in the frame.

```APIDOC
## frame_off_savregs_ea

### Description
Get starting address of saved registers section

### Signature
`frame_off_savregs_ea(func_ea: ida_idaapi.ea_t) -> ida_idaapi.ea_t`

### Parameters
- **func_ea** (ida_idaapi.ea_t) - Required - any address of the function

### Returns
- **ida_idaapi.ea_t** - offset in frame or BADADDR on failure
```

--------------------------------

### line_rendering_output_entries_refs_t.begin(_*args)

Source: https://python.docs.hex-rays.com/ida_kernwin/index.html

Returns an iterator to the beginning of the container.

```APIDOC
## begin(_*args)

### Description
Returns an iterator to the beginning of the container.

### Method
begin

### Signature
begin(_*args) → qvector< line_rendering_output_entry_t * >::const_iterator

### Parameters
- **_*args** - Required - Optional arguments (e.g., const overload).

### Returns
qvector< line_rendering_output_entry_t * >::const_iterator - An iterator to the beginning.

```

--------------------------------

### uint64vec_t.begin(*args)

Source: https://python.docs.hex-rays.com/ida_pro/index.html

Returns an iterator to the beginning of the vector.

```APIDOC
## begin(*args)

### Description
Returns an iterator to the beginning of the vector.

### Method
begin

### Signature
begin(_*args_) → qvector< unsigned long long >::const_iterator

### Parameters
- **args** - Variable arguments.

### Returns
- **qvector< unsigned long long >::const_iterator** - Iterator to the first element.

### Example
```python
it = vec.begin()
```
```

--------------------------------

### frame_off_retaddr_ea

Source: https://python.docs.hex-rays.com/ida_frame/index.html

Gets the starting address of the return address section in the frame.

```APIDOC
## frame_off_retaddr_ea

### Description
Get starting address of return address section

### Signature
`frame_off_retaddr_ea(func_ea: ida_idaapi.ea_t) -> ida_idaapi.ea_t`

### Parameters
- **func_ea** (ida_idaapi.ea_t) - Required - any address of the function

### Returns
- **ida_idaapi.ea_t** - offset in frame or BADADDR on failure
```

--------------------------------

### install_user_defined_prefix

Source: https://python.docs.hex-rays.com/ida_lines/index.html

Installs a user-defined prefix.

```APIDOC
## install_user_defined_prefix

### Description
Installs a user-defined prefix.

### Signature
`install_user_defined_prefix()` -> bool

### Parameters
None documented.

### Returns
- **bool** - True on success, False on failure.
```

--------------------------------

### idautils.Chunks(start)

Source: https://python.docs.hex-rays.com/idautils/index.html

Get a list of function chunks for the function at the given address.

```APIDOC
## idautils.Chunks(start)

### Description
Get a list of function chunks for the function at the given address.

### Parameters
- **start** - address of the function

### Returns
list of function chunks (tuples of the form (start_ea, end_ea)) belonging to the function
```

--------------------------------

### new_til

Source: https://python.docs.hex-rays.com/ida_typeinf/index.html

Initializes a til (type library).

```APIDOC
## new_til

### Description
Initializes a til (type library).

### Signature
`new_til() -> til_t *`

### Returns
- (til_t *) - A pointer to the initialized til.

```

--------------------------------

### ida_frame.frame_off_lvars

Source: https://python.docs.hex-rays.com/ida_frame/index.html

Gets the start address of the local variables section of a function frame.

```APIDOC
## frame_off_lvars(pfn)

### Description
Get start address of local variables section.

### Parameters
- **pfn** (func_t const *) - Required - pointer to function

### Returns
- start address of local variables section
```

--------------------------------

### UI_Hooks.initing_database

Source: https://python.docs.hex-rays.com/ida_kernwin/index.html

Called when database initialization has started. This event is called for both new and old databases.

```APIDOC
## initing_database

### Description
Called when database initialization has started. This event is called for both new and old databases.

### Method
Callback (UI_Hooks)

### Signature
`initing_database() -> None`

### Parameters
None

### Returns
void

### See Also
ui_database_inited
```

--------------------------------

### DOPT_START_BPT

Source: https://python.docs.hex-rays.com/ida_dbg/index.html

Debugger option: break on process start.

```APIDOC
## DOPT_START_BPT

### Description
Break on process start.

### Type
Integer constant

### Value
(not specified in source)

### Usage
Used as a debugger option flag.
```

--------------------------------

### ida_frame.frame_off_savregs

Source: https://python.docs.hex-rays.com/ida_frame/index.html

Gets the starting address of the saved registers section of a function frame.

```APIDOC
## frame_off_savregs(pfn)

### Description
Get starting address of saved registers section.

### Parameters
- **pfn** (func_t const *) - Required - pointer to function

### Returns
- starting address of saved registers section
```

--------------------------------

### ida_frame.frame_off_retaddr

Source: https://python.docs.hex-rays.com/ida_frame/index.html

Gets the starting address of the return address section of a function frame.

```APIDOC
## frame_off_retaddr(pfn)

### Description
Get starting address of return address section.

### Parameters
- **pfn** (func_t const *) - Required - pointer to function

### Returns
- starting address of return address section
```

--------------------------------

### hx_mba_t_for_all_insns

Source: https://python.docs.hex-rays.com/ida_hexrays/index.html

Iterates over all instructions in the MBA.

```APIDOC
## hx_mba_t_for_all_insns

### Description
Iterates over all instructions in the MBA.

### Method
N/A (Python SDK method)

### Signature
`hx_mba_t_for_all_insns()`

### Parameters
None

### Returns
None
```

--------------------------------

### UI_Hooks.idcstart

Source: https://python.docs.hex-rays.com/ida_kernwin/index.html

Called at the start of IDC engine work.

```APIDOC
## UI_Hooks.idcstart

### Description
Start of IDC engine work.

### Method
Callback

### Signature
idcstart() → None

### Returns
void
```

--------------------------------

### ida_frame.frame_off_lvars_ea

Source: https://python.docs.hex-rays.com/ida_frame/index.html

Gets the start address of the local variables section for a given function.

```APIDOC
## frame_off_lvars_ea(func_ea)

### Description
Get start address of local variables section.

### Parameters
- **func_ea** (ida_idaapi.ea_t) - Required - any address of the function

### Returns
- offset in frame or BADADDR on failure
```

--------------------------------

### enable_bpt

Source: https://python.docs.hex-rays.com/ida_dbg/index.html

Enable a breakpoint.

```APIDOC
## enable_bpt

### Description
Enable a breakpoint.

### Returns
- **bool** - True on success.
```

--------------------------------

### get_segment_ea(ea) -> ea_t

Source: https://python.docs.hex-rays.com/ida_segment/index.html

Gets the segment start address for a given linear address.

```APIDOC
## get_segment_ea(ea) -> ea_t

### Description
Gets the segment start address for a given linear address.

### Method
Function call

### Signature
`get_segment_ea(ea: ea_t) -> ea_t`

### Parameters
- **ea** (ea_t) - Required - Linear address belonging to the segment

### Returns
- **ea_t** - segment start_ea, or BADADDR if not found
```

--------------------------------

### setup_selector

Source: https://python.docs.hex-rays.com/ida_segment/index.html

Allocates a selector for a segment if necessary. Must be called before add_segm_ex() unless using add_segm(). Returns sel_t.

```APIDOC
## setup_selector

### Description
Allocates a selector for a segment if necessary. Must be called before add_segm_ex() unless using add_segm().

### Returns
- **sel_t** - The allocated selector.

```

--------------------------------

### get_item_head

Source: https://python.docs.hex-rays.com/ida_bytes/index.html

Get the start address of the item at 'ea'. If there is no current item, then 'ea' is returned.

```APIDOC
## get_item_head

### Description
Get the start address of the item at 'ea'. If there is no current item, then 'ea' is returned (see definition at the end of bytes.hpp source).

### Return Type
ida_idaapi.ea_t
```

--------------------------------

### idc.prev_head

Source: https://python.docs.hex-rays.com/idc/index.html

Get the previous defined item (instruction or data) in the program starting from a given address.

```APIDOC
## idc.prev_head

### Description
Get previous defined item (instruction or data) in the program.

### Parameters
- **ea** (linear address) - Required - Linear address to start search from.
- **minea** (linear address) - Optional - The search will stop at the address minea is included in the search range.

### Returns
BADADDR - no (more) defined items.
```

--------------------------------

### debugger_t.ev_start_process

Source: https://python.docs.hex-rays.com/ida_idd/index.html

Start an executable to debug. This event is generated in debthread. Must be implemented.

```APIDOC
## ev_start_process

### Description
Start an executable to debug. This event is generated in debthread. Must be implemented.

```

--------------------------------

### idc.next_head

Source: https://python.docs.hex-rays.com/idc/index.html

Get the next defined item (instruction or data) in the program starting from a given address.

```APIDOC
## idc.next_head

### Description
Get next defined item (instruction or data) in the program.

### Parameters
- **ea** (linear address) - Required - Linear address to start search from.
- **maxea** (linear address) - Required - The search will stop at the address maxea is not included in the search range.

### Returns
BADADDR - no (more) defined items.
```

--------------------------------

### inf_get_start_cs

Source: https://python.docs.hex-rays.com/ida_ida/index.html

Returns the starting code segment selector.

```APIDOC
## inf_get_start_cs

### Description
Returns the starting code segment selector.

### Method
Function

### Signature
`ida_ida.inf_get_start_cs() -> sel_t`

### Parameters
None

### Returns
- **sel_t** - The starting code segment selector.
```

--------------------------------

### item_block_locator_t.setup_blocks

Source: https://python.docs.hex-rays.com/ida_merge/index.html

Sets up blocks for merging between two databases.

```APIDOC
## setup_blocks(md, _from, to, region) -> bool

### Description
Sets up blocks for merging between two databases.

### Method
setup_blocks

### Parameters
- **md** (merge_data_t) - Required - Merge data object.
- **_from** (diff_source_idx_t) - Required - Source database index.
- **to** (diff_source_idx_t) - Required - Destination database index.
- **region** (diff_range_t const &) - Required - Region to set up blocks for.

### Returns
- **bool** - Success indicator.
```

--------------------------------

### idautils.Functions(start=None, end=None)

Source: https://python.docs.hex-rays.com/idautils/index.html

Get a list of function entrypoints between the given start and end addresses.

```APIDOC
## idautils.Functions(start=None, end=None)

### Description
Get a list of function entrypoints between the given start and end addresses.

### Parameters
- **start** - start address (default: inf.min_ea)
- **end** - end address (default: inf.max_ea)

### Returns
list of function entrypoints between start and end

### Note
The last function that starts before 'end' is included even if it extends beyond 'end'. Any function that has its chunks scattered in multiple segments will be reported multiple times, once in each segment as they are listed.
```

--------------------------------

### ida_hexrays.create_helper(*args)

Source: https://python.docs.hex-rays.com/ida_hexrays/index.html

Creates a helper object.

```APIDOC
## ida_hexrays.create_helper(*args)

### Description
Create a helper object.
```

--------------------------------

### get_first_segment_ea

Source: https://python.docs.hex-rays.com/ida_segment/index.html

Get start address of the first segment. The returned address can be used as a handle for other segment_* functions.

```APIDOC
## get_first_segment_ea

### Description
Get start address of the first segment. The returned address can be used as a handle for other segment_* functions.

### Returns
- **ida_idaapi.ea_t** - The start address of the first segment.
```

--------------------------------

### get_segment_ea_by_num

Source: https://python.docs.hex-rays.com/ida_segment/index.html

Get segment start address by its number. The returned address can be used as a handle for other segment_* functions.

```APIDOC
## get_segment_ea_by_num

### Description
Get segment start address by its number. The returned address can be used as a handle for other segment_* functions.

### Returns
- **ida_idaapi.ea_t** - The segment start address.
```

--------------------------------

### ida_kernwin.choose_entry

Source: https://python.docs.hex-rays.com/ida_kernwin/index.html

Chooses an entry point. Returns the ea of the selected entry point or BADADDR if none selected.

```APIDOC
## ida_kernwin.choose_entry

### Description
Choose an entry point (ui_choose, chtype_entry).

### Signature
`ida_kernwin.choose_entry(title: str) -> ea_t`

### Parameters
- **title** (str) - Required - Chooser title.

### Returns
- **ea_t** - EA of selected entry point.
- **BADADDR** - If none selected.
```
Tokens:
Raw