Latest available version: IDA and decompilers v8.4.240320sp1 see all releases
Hex-Rays logo State-of-the-art binary code analysis tools
email icon
plugin_t Class Reference

A plugin is a module in the plugins subdirectory that can perform an action asked by the user. More...

#include <loader.hpp>

Public Attributes

int version
 Should be equal to IDP_INTERFACE_VERSION.
 
int flags
 Plugin features
 
plugmod_t *(idaapi * init )(void)
 Initialize plugin - returns a pointer to plugmod_t.
 
void(idaapi * term )(void)
 Terminate plugin. More...
 
bool(idaapi * run )(size_t arg)
 Invoke plugin. More...
 
const char * comment
 Long comment about the plugin. More...
 
const char * help
 Multiline help about the plugin.
 
const char * wanted_name
 The preferred short name of the plugin.
 
const char * wanted_hotkey
 The preferred hotkey to run the plugin.
 

Detailed Description

A plugin is a module in the plugins subdirectory that can perform an action asked by the user.

(usually via pressing a hotkey)

Member Data Documentation

◆ term

void(idaapi * plugin_t::term) (void)

Terminate plugin.

This function will be called when the plugin is unloaded. May be nullptr. Must be nullptr for PLUGIN_MULTI plugins

◆ run

bool(idaapi * plugin_t::run) (size_t arg)

Invoke plugin.

Must be nullptr for PLUGIN_MULTI plugins

◆ comment

const char* plugin_t::comment

Long comment about the plugin.

it could appear in the status line or as a hint


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