ida_domain.CommentsIterator Class Reference

Inherits object.

Public Member Functions
def	__init__ (self, database, include_repeatable=False)
def	get_first (self)
def	get_next (self)
"Iterator[Tuple[ea_t, str]]"	__iter__ (self)

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

Detailed Description

Iterator for user-defined comments in the IDA database.

Constructor & Destructor Documentation

__init__()

def ida_domain.CommentsIterator.__init__	(		self,
			database,
			include_repeatable = False
	)

Iterator(database, include_repeatable=False) -> CommentsIterator
Constructs a comment iterator for the given database.

:param database: Reference to the active IDA database.
:param include_repeatable: Whether to include repeatable comments during iteration.

Member Function Documentation

__iter__()

"Iterator[Tuple[ea_t, str]]" ida_domain.CommentsIterator.__iter__

(

self

)

__iter__(self) -> Iterator[Tuple[ea_t, str]]

get_first()

def ida_domain.CommentsIterator.get_first

(

self

)

get_first(self) -> EAStringPair
Retrieves the first comment in the database.

:return: A pair (address, comment string). If no comments exist, the string is empty.

get_next()

def ida_domain.CommentsIterator.get_next

(

self

)

get_next(self) -> EAStringPair
Retrieves the next comment in the database.

:return: A pair (address, comment string). If no more comments exist, the string is empty.

Property Documentation

thisown

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

static