IDA Domain Python API
ida_domain.Names Class Reference

Inherits object.

Public Member Functions

def __init__ (self, database)
 
def get_at (self, ea)
 
def get_count (self)
 
def get_at_index (self, index)
 
def get_all (self)
 

Properties

 thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
 

Detailed Description

Provides access to symbol and label management in the IDA database.

Constructor & Destructor Documentation

◆ __init__()

def ida_domain.Names.__init__ (   self,
  database 
)
__init__(self, database) -> Names
Constructs a names handler for the given database.

:param database: Reference to the active IDA database.

Member Function Documentation

◆ get_all()

def ida_domain.Names.get_all (   self)
get_all(self) -> NamesIterator
Returns an iterator over all named elements in the database.

:return: A names iterator.

◆ get_at()

def ida_domain.Names.get_at (   self,
  ea 
)
get_at(self, ea) -> BoolStringPair
Retrieves the name at the specified address.

:param ea: The effective address.
:return: A pair (bool success, name string). If the name doesn't exist, bool is false.

◆ get_at_index()

def ida_domain.Names.get_at_index (   self,
  index 
)
get_at_index(self, index) -> EAStringPair
Retrieves the named element at the specified index.

:param index: The index in the name list.
:return: A pair (effective address, name string) at the given index.

◆ get_count()

def ida_domain.Names.get_count (   self)
get_count(self) -> int
Retrieves the total number of named elements in the database.

:return: The count of named elements.

Property Documentation

◆ thisown

ida_domain.Names.thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc="The membership flag")
static