IDA Domain
Comments::Iterator Class Reference

Iterator for user-defined comments in the IDA database. More...

#include <comment.hpp>

Public Member Functions

 Iterator (const Database &database, bool include_repeatable=false)
 Constructs a comment iterator for the given database. More...
 
std::pair< ea_t, std::string > get_first ()
 Retrieves the first comment in the database. More...
 
std::pair< ea_t, std::string > get_next ()
 Retrieves the next comment in the database. More...
 

Detailed Description

Iterator for user-defined comments in the IDA database.

Constructor & Destructor Documentation

◆ Iterator()

Comments::Iterator::Iterator ( const Database database,
bool  include_repeatable = false 
)
inline

Constructs a comment iterator for the given database.

Parameters
databaseReference to the active IDA database.
include_repeatableWhether to include repeatable comments during iteration.

Member Function Documentation

◆ get_first()

std::pair<ea_t, std::string> Comments::Iterator::get_first ( )

Retrieves the first comment in the database.

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

◆ get_next()

std::pair<ea_t, std::string> Comments::Iterator::get_next ( )

Retrieves the next comment in the database.

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

The documentation for this class was generated from the following file: