Elektra: kdbplugin.h File Reference

Elektra 0.8.24

Macros | Enumerations | Functions
kdbplugin.h File Reference

Methods for plugin programing. More...

`#include <kdb.h>`
`#include <errno.h>`
`#include <kdbmacros.h>`
`#include <string.h>`

## Macros
#define | ELEKTRA_PLUGIN_FUNCTION(module, function) libelektra_##module##_LTX_elektraPlugin##function
| Declare a plugin's function name suitable for compilation variants (see doc/tutorials). More...
#define | ELEKTRA_README(module) ELEKTRA_README2 (module)
| The filename for inclusion of the readme for compilation variants (see doc/tutorials). More...
#define | ELEKTRA_PLUGIN_STATUS_ERROR -1
| An error occurred inside the plugin function.
#define | ELEKTRA_PLUGIN_STATUS_SUCCESS 1
| Everything went fine.
#define | ELEKTRA_PLUGIN_STATUS_NO_UPDATE 0
| Everything went fine and the function did not update the given keyset/configuration.

## Enumerations
enum | plugin_t { ELEKTRA_PLUGIN_OPEN =1, ELEKTRA_PLUGIN_CLOSE =1<<1, ELEKTRA_PLUGIN_GET =1<<2, ELEKTRA_PLUGIN_SET =1<<3, ELEKTRA_PLUGIN_ERROR =1<<4, ELEKTRA_PLUGIN_END =0 }
| Switches to denote the backend methods. More...

## Functions
Plugin * | elektraPluginExport (const char *pluginName,...)
| Allows one to Export Methods for a Plugin. More...
KeySet * | elektraPluginGetConfig (Plugin *handle)
| Returns the configuration of that plugin. More...
void | elektraPluginSetData (Plugin *plugin, void *handle)
| Store a pointer to any plugin related data. More...
void * | elektraPluginGetData (Plugin *plugin)
| Get a pointer to any plugin related data stored before. More...

## Detailed Description

Methods for plugin programing.

Copyright
  BSD License (see LICENSE.md or https://www.libelektra.org)

## Enumeration Type Documentation

## ◆ plugin_t

enum plugin_t

Switches to denote the backend methods.

Used in calls to elektraPluginExport().

Enumerator
ELEKTRA_PLUGIN_OPEN | Next arg is backend for kdbOpen()
ELEKTRA_PLUGIN_CLOSE | Next arg is backend for kdbClose()
ELEKTRA_PLUGIN_GET | Next arg is backend for kdbGet()
ELEKTRA_PLUGIN_SET | Next arg is backend for kdbSet()
ELEKTRA_PLUGIN_ERROR | Next arg is backend for kdbError()
ELEKTRA_PLUGIN_END | End of arguments