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 ()

bool	add_entry (int ord, ida_idaapi.ea_t ea, str name, bool makecode, int flags=0)

int	get_entry_ordinal ('size_t' idx)

ida_idaapi.ea_t	get_entry (int ord)

str	get_entry_name (int ord)

bool	rename_entry (int ord, str name, int flags=0)

bool	set_entry_forwarder (int ord, str name, int flags=0)

str	get_entry_forwarder (int ord)

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	(	int	ord,
		ida_idaapi.ea_t	ea,
		str	name,
		bool	makecode,
		int	flags = 0 )

Add an entry point to the list of entry points. 
    
@param ord: ordinal number if ordinal number is equal to 'ea' then ordinal is not used
@param ea: linear address
@param 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 == nullptr, then the old name will be retained.
@param makecode: should the kernel convert bytes at the entry point to instruction(s)
@param flags: See AEF_*
@returns success (currently always true)

◆ get_entry()

ida_idaapi.ea_t get_entry ( int ord )

Get entry point address by its ordinal 
    
@param ord: ordinal number of entry point
@returns address or BADADDR

◆ get_entry_forwarder()

str get_entry_forwarder ( int ord )

Get forwarder name for the entry point by its ordinal. 
    
@param ord: ordinal number of entry point
@returns size of entry forwarder name or -1

◆ get_entry_name()

str get_entry_name ( int ord )

Get name of the entry point by its ordinal. 
    
@param ord: ordinal number of entry point
@returns size of entry name or -1

◆ get_entry_ordinal()

int get_entry_ordinal ( 'size_t' idx )

Get ordinal number of an entry point. 
    
@param idx: 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 ( )

Get number of entry points.

◆ rename_entry()

bool rename_entry	(	int	ord,
		str	name,
		int	flags = 0 )

Rename entry point. 
    
@param ord: ordinal number of the entry point
@param name: name of entry point. If the specified location already has a name, the old name will be appended to a repeatable comment.
@param flags: See AEF_*
@returns success

◆ set_entry_forwarder()

bool set_entry_forwarder	(	int	ord,
		str	name,
		int	flags = 0 )

Set forwarder name for ordinal. 
    
@param ord: ordinal number of the entry point
@param name: forwarder name for entry point.
@param flags: 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