Routines for interacting with the plugin system. More...
Collaboration diagram for plugin:
|
Functions | |
| plugin * | plugin_new (char *i_name) |
| creates new plugin instance. | |
| void | plugin_free (plugin *i_plugin) |
| frees plugin instance. | |
| void | plugin_parse (plugin_info *i_plugin_info, int i_argc, char **i_argv) |
| parses command line arguments | |
| plugin_info * | plugin_get_info (plugin *i_plugin) |
| runs plugin info | |
| void | plugin_init (plugin *i_plugin, int i_argc, char **i_argv) |
| runs plugin init routine. | |
| void | plugin_deinit (plugin *i_plugin) |
| runs plugin deinit routine. | |
| void * | plugin_run (plugin *i_plugin, void *i_data) |
| runs plugin main routine. | |
| void | plugin_info_print (plugin_info *i_plugin_info) |
| print plugin information to stdout | |
| plugin_return * | plugin_return_new (int i_param_number) |
| create new plugin_return object | |
| void | plugin_return_free (plugin_return *i_plugin_return) |
| free plugin_return object | |
Detailed Description
Routines for interacting with the plugin system.
Function Documentation
| plugin* plugin_new | ( | char * | i_name | ) |
creates new plugin instance.
- Parameters:
-
i_name name of plugin
- Returns:
- plugin instance (free with plugin_free)
| void plugin_free | ( | plugin * | i_plugin | ) |
frees plugin instance.
- Parameters:
-
i_plugin plugin instance
| void plugin_parse | ( | plugin_info * | i_plugin_info, |
| int | i_argc, | ||
| char ** | i_argv | ||
| ) |
parses command line arguments
- Parameters:
-
i_plugin_info plugin info object i_argc number of arguments i_argv command line arguments
| plugin_info* plugin_get_info | ( | plugin * | i_plugin | ) |
runs plugin info
- Parameters:
-
i_plugin plugin instance
- Returns:
- plugin info structure
| void plugin_init | ( | plugin * | i_plugin, |
| int | i_argc, | ||
| char ** | i_argv | ||
| ) |
runs plugin init routine.
- Parameters:
-
i_plugin plugin instance i_argc number of arguments i_argv array of argmuments
| void* plugin_run | ( | plugin * | i_plugin, |
| void * | i_data | ||
| ) |
runs plugin main routine.
- Parameters:
-
i_plugin plugin instance i_data user data
| void plugin_info_print | ( | plugin_info * | i_plugin_info | ) |
print plugin information to stdout
- Parameters:
-
i_plugin_info plugin_info instance
| plugin_return* plugin_return_new | ( | int | i_param_number | ) |
create new plugin_return object
- Parameters:
-
i_param_number number of parameters
free object with plugin_return _free
| void plugin_return_free | ( | plugin_return * | i_plugin_return | ) |
free plugin_return object
- Parameters:
-
i_plugin_return plugin_return object
