Entries
Classes:
-
Entries–Provides access to entries in the IDA database.
-
EntryInfo–Represents a program entry point.
-
ForwarderInfo–Represents information about an entry point forwarder.
Entries(database: Database)
Bases: DatabaseEntity
Provides access to entries in the IDA database.
Can be used to iterate over all entries in the opened database.
Args: database: Reference to the active IDA database.
Methods:
-
add–Add a new entry point.
-
exists–Check if an entry point with the given ordinal exists.
-
get_addresses–Get all entry point addresses.
-
get_all–Get all entry points.
-
get_at_index–Get entry point by its index in the entry table.
-
get_by_address–Get entry point by its address.
-
get_by_name–Find entry point by name.
-
get_by_ordinal–Get entry point by its ordinal number.
-
get_count–Get the total number of entry points.
-
get_forwarders–Get all entry points that have forwarders.
-
get_names–Get all entry point names.
-
get_ordinals–Get all ordinal numbers.
-
rename–Rename an existing entry point.
-
set_forwarder–Set forwarder name for an entry point.
Attributes:
-
database(Database) –Get the database reference, guaranteed to be non-None when called from
-
m_database–
property
database: Database
Get the database reference, guaranteed to be non-None when called from methods decorated with @check_db_open.
Returns: The active database instance.
Note: This property should only be used in methods decorated with @check_db_open, which ensures m_database is not None.
instance-attribute
m_database = database
add(
address: ea_t,
name: str,
ordinal: Optional[int] = None,
make_code: bool = True,
) -> bool
Add a new entry point.
Args: address: Linear address of the entry point name: Name for the entry point ordinal: Ordinal number (if None, uses address as ordinal) make_code: Whether to convert bytes to instructions
Returns: bool: True if successful
exists(ordinal: int) -> bool
Check if an entry point with the given ordinal exists.
Args: ordinal: Ordinal number to check
Returns: bool: True if entry point exists
get_addresses() -> Iterator[ea_t]
Get all entry point addresses.
Yields: int: Each entry point address
get_all() -> Iterator[EntryInfo]
Get all entry points.
Yields: Entry: Each entry point in the program
get_at_index(index: int) -> EntryInfo
Get entry point by its index in the entry table.
Args: index: Internal index (0 to get_count()-1)
Returns: Entry: The entry point at the specified index
Raises: IndexError: If index is out of range
get_by_address(address: ea_t) -> EntryInfo | None
Get entry point by its address.
Args: address: Linear address to search for
Returns: Entry: The entry point at the specified address, or None if not found
get_by_name(name: str) -> EntryInfo | None
Find entry point by name.
Args: name: Name to search for
Returns: Entry: The entry point with the specified name, or None if not found
get_by_ordinal(ordinal: int) -> EntryInfo | None
Get entry point by its ordinal number.
Args: ordinal: Ordinal number of the entry point
Returns: Entry: The entry point with the specified ordinal, or None if not found
get_count() -> int
Get the total number of entry points.
Returns: int: Number of entry points in the program
get_forwarders() -> Iterator[ForwarderInfo]
Get all entry points that have forwarders.
Yields: ForwarderInfo: Information about each entry with a forwarder
get_names() -> Iterator[str]
Get all entry point names.
Yields: str: Each entry point name
get_ordinals() -> Iterator[int]
Get all ordinal numbers.
Yields: int: Each ordinal number
rename(ordinal: int, new_name: str) -> bool
Rename an existing entry point.
Args: ordinal: Ordinal number of the entry point new_name: New name for the entry point
Returns: bool: True if successful
set_forwarder(ordinal: int, forwarder_name: str) -> bool
Set forwarder name for an entry point.
Args: ordinal: Ordinal number of the entry point forwarder_name: Forwarder name to set
Returns: bool: True if successful
dataclass
EntryInfo(
ordinal: int,
address: ea_t,
name: str,
forwarder_name: str,
)
Represents a program entry point. Exported functions are considered entry points as well.
Methods:
-
has_forwarder–Check if this entry point has a forwarder.
Attributes:
-
address(ea_t) – -
forwarder_name(str) – -
name(str) – -
ordinal(int) –
instance-attribute
address: ea_t
instance-attribute
forwarder_name: str
instance-attribute
name: str
instance-attribute
ordinal: int
has_forwarder() -> bool
Check if this entry point has a forwarder.