ida_entry Namespace Reference

Detailed Description

Functions that deal with entry points.

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

Functions
"size_t"	get_entry_qty (*args)
	get_entry_qty() -> size_t Get number of entry points.
"bool"	add_entry (*args)
	add_entry(ord, ea, name, makecode, flags=0) -> bool Add an entry point to the list of entry points.
"uval_t"	get_entry_ordinal (*args)
	get_entry_ordinal(idx) -> uval_t Get ordinal number of an entry point.
"ea_t"	get_entry (*args)
	get_entry(ord) -> ea_t Get entry point address by its ordinal
"qstring *"	get_entry_name (*args)
	get_entry_name(ord) -> str Get name of the entry point by its ordinal.
"bool"	rename_entry (*args)
	rename_entry(ord, name, flags=0) -> bool Rename entry point.
"bool"	set_entry_forwarder (*args)
	set_entry_forwarder(ord, name, flags=0) -> bool Set forwarder name for ordinal.
"qstring *"	get_entry_forwarder (*args)
	get_entry_forwarder(ord) -> str Get forwarder name for the entry point by its ordinal.

Variables
	AEF_UTF8 = _ida_entry.AEF_UTF8
	AEF_IDBENC = _ida_entry.AEF_IDBENC
	AEF_NODUMMY = _ida_entry.AEF_NODUMMY

Function Documentation

add_entry()

"bool" add_entry

(

*

args

)

Parameters

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_*

Returns

: success (currently always true)

get_entry()

"ea_t" get_entry

(

*

args

)

Parameters

ord	(C++: uval_t) ordinal number of entry point

Returns

: address or BADADDR

get_entry_forwarder()

"qstring *" get_entry_forwarder

(

*

args

)

Parameters

ord	(C++: uval_t) ordinal number of entry point

Returns

: size of entry forwarder name or -1

get_entry_name()

"qstring *" get_entry_name

(

*

args

)

Parameters

ord	(C++: uval_t) ordinal number of entry point

Returns

: size of entry name or -1

get_entry_ordinal()

"uval_t" get_entry_ordinal

(

*

args

)

Parameters

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

Returns

: ordinal number or 0.

get_entry_qty()

"size_t" get_entry_qty

(

*

args

)

rename_entry()

"bool" rename_entry

(

*

args

)

Parameters

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_*

Returns

: success

set_entry_forwarder()

"bool" set_entry_forwarder

(

*

args

)

Parameters

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

Returns

: success

Variable Documentation

AEF_IDBENC

AEF_IDBENC = _ida_entry.AEF_IDBENC

AEF_NODUMMY

AEF_NODUMMY = _ida_entry.AEF_NODUMMY

AEF_UTF8

AEF_UTF8 = _ida_entry.AEF_UTF8