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

#include <loader.hpp>

Public Member Functions
plugmod_t idaapi	init (void)
	Initialize plugin - returns a pointer to plugmod_t.
	void (idaapi *term)(void)
	Terminate plugin.
	bool (idaapi *run)(size_t arg)
	Invoke plugin.

Public Attributes
int	version
	Should be equal to #IDP_INTERFACE_VERSION.
int	flags
	Plugin features
const char *	comment
	Long comment about the plugin.
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 Function Documentation

◆ init()

plugmod_t *idaapi * plugin_t::init ( void )

Initialize plugin - returns a pointer to plugmod_t.

◆ void()

plugin_t::void ( idaapi * term )

Terminate plugin.

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

◆ bool()

plugin_t::bool ( idaapi * run )

Invoke plugin.

Must be nullptr for PLUGIN_MULTI plugins

Member Data Documentation

◆ version

int plugin_t::version

Should be equal to #IDP_INTERFACE_VERSION.

◆ flags

int plugin_t::flags

Plugin features

◆ comment

const char* plugin_t::comment

Long comment about the plugin.

it could appear in the status line or as a hint

◆ help

const char* plugin_t::help

Multiline help about the plugin.

◆ wanted_name

const char* plugin_t::wanted_name

The preferred short name of the plugin.

◆ wanted_hotkey

const char* plugin_t::wanted_hotkey

The preferred hotkey to run the plugin.

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

ida-sdk/src/include/loader.hpp

Public Member Functions

Public Attributes