1. Manuals
  2. Leap-15.6
  3. libelektra-devel-doc
  4. doc.h(3elektra)

Scroll to navigation

doc.h(3elektra) Elektra doc.h(3elektra)

NAME

doc.h

SYNOPSIS

#include <kdbplugin.h>

Macros


#define ELEKTRA_SET_ERROR(number, key, text)
Sets the error in the keys metadata. #define ELEKTRA_SET_ERRORF(number, key, formatstring, ...)
Sets the error in the keys metadata. #define ELEKTRA_ADD_WARNINGF(number, key, formatstring, ...)
Adds a warning in the keys metadata. #define ELEKTRA_ADD_WARNING(number, key, text)
Adds a warning in the keys metadata. #define ELEKTRA_SET_ERROR_GET(parentKey)
Set error in kdbGet() when opening the file failed. #define ELEKTRA_SET_ERROR_SET(parentKey)
Set error in kdbSet() when opening the file failed.

Functions


int elektraDocOpen (Plugin *handle, Key *warningsKey)
Initialize data for the plugin. int elektraDocClose (Plugin *handle, Key *warningsKey)
Finalize the plugin. int elektraDocGet (Plugin *handle, KeySet *returned, Key *parentKey)
Get data from storage to application. int elektraDocSet (Plugin *handle, KeySet *returned, Key *parentKey)
Set data from application to storage. int elektraDocError (Plugin *handle, KeySet *returned, Key *parentKey)
Rollback in case of errors. int elektraDocCheckConf (Key *errorKey, KeySet *conf)
Validate plugin configuration at mount time.

Detailed Description

Copyright:

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

Author

Generated automatically by Doxygen for Elektra from the source code.

Mon Jan 15 2018 Version 0.8.20