Module ida_entry
[frames] | no frames]

Module ida_entry

IDA Plugin SDK API wrapper: entry

Functions
size_t
get_entry_qty()
Get number of entry points.
bool
add_entry(ord, ea, name, makecode, flags=0x0)
Add an entry point to the list of entry points.
uval_t
get_entry_ordinal(idx)
Get ordinal number of an entry point.
ea_t
get_entry(ord)
Get entry point address by its ordinal
ssize_t
get_entry_name(ord)
Get name of the entry point by its ordinal.
bool
rename_entry(ord, name, flags=0x0)
Rename entry point.
bool
set_entry_forwarder(ord, name, flags=0x0)
Set forwarder name for ordinal.
ssize_t
get_entry_forwarder(ord)
Get forwarder name for the entry point by its ordinal.
Variables
  AEF_UTF8 = 0
the name is given in UTF-8 (default)
  AEF_IDBENC = 1
the name is given in the IDB encoding; non-ASCII bytes will be decoded accordingly Specifying AEF_IDBENC also implies AEF_NODUMMY
  AEF_NODUMMY = 2
it begins with a dummy suffix.
  __package__ = None
Function Details

add_entry(ord, ea, name, makecode, flags=0x0)

 

Add an entry point to the list of entry points.

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

get_entry_ordinal(idx)

 

Get ordinal number of an entry point.

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

get_entry(ord)

 

Get entry point address by its ordinal

Parameters:
  • ord - ordinal number of entry point (C++: uval_t)
Returns: ea_t
address or BADADDR

get_entry_name(ord)

 

Get name of the entry point by its ordinal.

Parameters:
  • ord - ordinal number of entry point (C++: uval_t)
Returns: ssize_t
size of entry name or -1

rename_entry(ord, name, flags=0x0)

 

Rename entry point.

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

set_entry_forwarder(ord, name, flags=0x0)

 

Set forwarder name for ordinal.

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

get_entry_forwarder(ord)

 

Get forwarder name for the entry point by its ordinal.

Parameters:
  • ord - ordinal number of entry point (C++: uval_t)
Returns: ssize_t
size of entry forwarder name or -1

Variables Details

AEF_NODUMMY

it begins with a dummy suffix. See also AEF_IDBENC

automatically prepend the name with '_' if

Value:
2