Module ida_entry

Exported functions are considered as entry points as well.

IDA maintains list of entry points to the program. Each entry point:

  • has an address

  • has a name

  • may have an ordinal number

Global Variables

AEF_IDBENC

AEF_IDBENC = 1

AEF_NODUMMY

AEF_NODUMMY = 2

AEF_UTF8

AEF_UTF8 = 0

Functions

add_entry(ord: uval_t, ea: ea_t, name: char const *, makecode: bool, flags: int = 0) ‑> bool

add_entry(ord, ea, name, makecode, flags=0) -> bool Add an entry point to the list of entry points.

ord: (C++: uval_t) ordinal number if ordinal number is equal to 'ea' then ordinal is
           not used
ea: (C++: ea_t) linear address
name: (C++: const char *) name of entry point. If the specified location already has a name,
            the old name will be appended to the regular comment. If name ==
            nullptr, then the old name will be retained.
makecode: (C++: bool) should the kernel convert bytes at the entry point to
                instruction(s)
flags: (C++: int) See AEF_*
return: success (currently always true)

get_entry(ord: uval_t) ‑> ea_t

get_entry(ord) -> ea_t Get entry point address by its ordinal

ord: (C++: uval_t) ordinal number of entry point
return: address or BADADDR

get_entry_forwarder(ord: uval_t) ‑> qstring *

get_entry_forwarder(ord) -> str Get forwarder name for the entry point by its ordinal.

ord: (C++: uval_t) ordinal number of entry point
return: size of entry forwarder name or -1

get_entry_name(ord: uval_t) ‑> qstring *

get_entry_name(ord) -> str Get name of the entry point by its ordinal.

ord: (C++: uval_t) ordinal number of entry point
return: size of entry name or -1

get_entry_ordinal(idx: size_t) ‑> uval_t

get_entry_ordinal(idx) -> uval_t Get ordinal number of an entry point.

idx: (C++: size_t) internal number of entry point. Should be in the range
           0..get_entry_qty()-1
return: ordinal number or 0.

get_entry_qty() ‑> size_t

get_entry_qty() -> size_t Get number of entry points.

rename_entry(ord: uval_t, name: char const *, flags: int = 0) ‑> bool

rename_entry(ord, name, flags=0) -> bool Rename entry point.

ord: (C++: uval_t) ordinal number of the entry point
name: (C++: const char *) name of entry point. If the specified location already has a name,
            the old name will be appended to a repeatable comment.
flags: (C++: int) See AEF_*
return: success

set_entry_forwarder(ord: uval_t, name: char const *, flags: int = 0) ‑> bool

set_entry_forwarder(ord, name, flags=0) -> bool Set forwarder name for ordinal.

ord: (C++: uval_t) ordinal number of the entry point
name: (C++: const char *) forwarder name for entry point.
flags: (C++: int) See AEF_*
return: success

Last updated