\hypertarget{kdbplugin_8h}{}\section{kdbplugin.\+h File Reference}
\label{kdbplugin_8h}\index{kdbplugin.\+h@{kdbplugin.\+h}}


Methods for plugin programing.  


{\ttfamily \#include $<$kdb.\+h$>$}\newline
{\ttfamily \#include $<$errno.\+h$>$}\newline
{\ttfamily \#include $<$kdbmacros.\+h$>$}\newline
{\ttfamily \#include $<$string.\+h$>$}\newline
Include dependency graph for kdbplugin.\+h\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{kdbplugin_8h__incl}
\end{center}
\end{figure}
This graph shows which files directly or indirectly include this file\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{kdbplugin_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Macros}
\begin{DoxyCompactItemize}
\item 
\#define \hyperlink{group__plugin_ga34d1a66f0a6e89cfd20f4014a9975a2a}{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+F\+U\+N\+C\+T\+I\+ON}(module,  function)~libelektra\+\_\+\#\#module\#\#\+\_\+\+L\+T\+X\+\_\+elektra\+Plugin\#\#function
\begin{DoxyCompactList}\small\item\em Declare a plugin\textquotesingle{}s function name suitable for compilation variants (see doc/tutorials). \end{DoxyCompactList}\item 
\#define \hyperlink{group__plugin_ga78d616f68bf9fb0942f66478597467c6}{E\+L\+E\+K\+T\+R\+A\+\_\+\+R\+E\+A\+D\+ME}(module)~E\+L\+E\+K\+T\+R\+A\+\_\+\+R\+E\+A\+D\+M\+E2 (module)
\begin{DoxyCompactList}\small\item\em The filename for inclusion of the readme for compilation variants (see doc/tutorials). \end{DoxyCompactList}\item 
\mbox{\Hypertarget{kdbplugin_8h_a0a5d59c7d1a2ce87a1d060c7be0261a4}\label{kdbplugin_8h_a0a5d59c7d1a2ce87a1d060c7be0261a4}} 
\#define \hyperlink{kdbplugin_8h_a0a5d59c7d1a2ce87a1d060c7be0261a4}{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+S\+T\+A\+T\+U\+S\+\_\+\+E\+R\+R\+OR}~-\/1
\begin{DoxyCompactList}\small\item\em An error occurred inside the plugin function. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{kdbplugin_8h_a7ae271ada880a1447179094ce6f66821}\label{kdbplugin_8h_a7ae271ada880a1447179094ce6f66821}} 
\#define \hyperlink{kdbplugin_8h_a7ae271ada880a1447179094ce6f66821}{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+S\+T\+A\+T\+U\+S\+\_\+\+S\+U\+C\+C\+E\+SS}~1
\begin{DoxyCompactList}\small\item\em Everything went fine. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{kdbplugin_8h_abcb047a0a65b91821f414770c662ed8e}\label{kdbplugin_8h_abcb047a0a65b91821f414770c662ed8e}} 
\#define \hyperlink{kdbplugin_8h_abcb047a0a65b91821f414770c662ed8e}{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+S\+T\+A\+T\+U\+S\+\_\+\+N\+O\+\_\+\+U\+P\+D\+A\+TE}~0
\begin{DoxyCompactList}\small\item\em Everything went fine and the function {\bfseries did not} update the given keyset/configuration. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Enumerations}
\begin{DoxyCompactItemize}
\item 
enum \hyperlink{kdbplugin_8h_afed89ef026fb0622918a5de020de7814}{plugin\+\_\+t} \{ \newline
\hyperlink{kdbplugin_8h_afed89ef026fb0622918a5de020de7814ab7e2dcc6e79af21dd90d2bb62920551d}{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+O\+P\+EN} =1, 
\hyperlink{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a449e166b322550b3ad26efd4c46e49e3}{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+C\+L\+O\+SE} =1$<$$<$1, 
\hyperlink{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a3d5f4a887e68878f1cc3a75985194204}{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+G\+ET} =1$<$$<$2, 
\hyperlink{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a85c9545261cf0bcc932616e67ea3b70a}{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+S\+ET} =1$<$$<$3, 
\newline
\hyperlink{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a89e027283d949dd78bb9c1fce1b19a10}{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+E\+R\+R\+OR} =1$<$$<$4, 
\hyperlink{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a64a0bc789482284d9fd27ce974e0959a}{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+E\+ND} =0
 \}\begin{DoxyCompactList}\small\item\em Switches to denote the backend methods. \end{DoxyCompactList}
\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
Plugin $\ast$ \hyperlink{group__plugin_ga8dd092048e972a3f0c9c9f54eb41576e}{elektra\+Plugin\+Export} (const char $\ast$plugin\+Name,...)
\begin{DoxyCompactList}\small\item\em Allows one to Export Methods for a Plugin. \end{DoxyCompactList}\item 
Key\+Set $\ast$ \hyperlink{group__plugin_ga644bead796506c172817724051c977c9}{elektra\+Plugin\+Get\+Config} (Plugin $\ast$handle)
\begin{DoxyCompactList}\small\item\em Returns the configuration of that plugin. \end{DoxyCompactList}\item 
void \hyperlink{group__plugin_gaf4b941a52ff55d0ca2a9158d90208ef2}{elektra\+Plugin\+Set\+Data} (Plugin $\ast$plugin, void $\ast$handle)
\begin{DoxyCompactList}\small\item\em Store a pointer to any plugin related data. \end{DoxyCompactList}\item 
void $\ast$ \hyperlink{group__plugin_gaafcf3216b46292f222b8cc7828b4dd20}{elektra\+Plugin\+Get\+Data} (Plugin $\ast$plugin)
\begin{DoxyCompactList}\small\item\em Get a pointer to any plugin related data stored before. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Methods for plugin programing. 

\begin{DoxyCopyright}{Copyright}
B\+SD License (see L\+I\+C\+E\+N\+S\+E.\+md or \href{https://www.libelektra.org}{\tt https\+://www.\+libelektra.\+org}) 
\end{DoxyCopyright}


\subsection{Enumeration Type Documentation}
\mbox{\Hypertarget{kdbplugin_8h_afed89ef026fb0622918a5de020de7814}\label{kdbplugin_8h_afed89ef026fb0622918a5de020de7814}} 
\index{kdbplugin.\+h@{kdbplugin.\+h}!plugin\+\_\+t@{plugin\+\_\+t}}
\index{plugin\+\_\+t@{plugin\+\_\+t}!kdbplugin.\+h@{kdbplugin.\+h}}
\subsubsection{\texorpdfstring{plugin\+\_\+t}{plugin\_t}}
{\footnotesize\ttfamily enum \hyperlink{kdbplugin_8h_afed89ef026fb0622918a5de020de7814}{plugin\+\_\+t}}



Switches to denote the backend methods. 

Used in calls to \hyperlink{group__plugin_ga8dd092048e972a3f0c9c9f54eb41576e}{elektra\+Plugin\+Export()}. \begin{DoxyEnumFields}{Enumerator}
\raisebox{\heightof{T}}[0pt][0pt]{\index{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+O\+P\+EN@{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+O\+P\+EN}!kdbplugin.\+h@{kdbplugin.\+h}}\index{kdbplugin.\+h@{kdbplugin.\+h}!E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+O\+P\+EN@{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+O\+P\+EN}}}\mbox{\Hypertarget{kdbplugin_8h_afed89ef026fb0622918a5de020de7814ab7e2dcc6e79af21dd90d2bb62920551d}\label{kdbplugin_8h_afed89ef026fb0622918a5de020de7814ab7e2dcc6e79af21dd90d2bb62920551d}} 
E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+O\+P\+EN&Next arg is backend for \hyperlink{group__kdb_ga6808defe5870f328dd17910aacbdc6ca}{kdb\+Open()} \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+C\+L\+O\+SE@{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+C\+L\+O\+SE}!kdbplugin.\+h@{kdbplugin.\+h}}\index{kdbplugin.\+h@{kdbplugin.\+h}!E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+C\+L\+O\+SE@{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+C\+L\+O\+SE}}}\mbox{\Hypertarget{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a449e166b322550b3ad26efd4c46e49e3}\label{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a449e166b322550b3ad26efd4c46e49e3}} 
E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+C\+L\+O\+SE&Next arg is backend for \hyperlink{group__kdb_gadb54dc9fda17ee07deb9444df745c96f}{kdb\+Close()} \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+G\+ET@{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+G\+ET}!kdbplugin.\+h@{kdbplugin.\+h}}\index{kdbplugin.\+h@{kdbplugin.\+h}!E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+G\+ET@{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+G\+ET}}}\mbox{\Hypertarget{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a3d5f4a887e68878f1cc3a75985194204}\label{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a3d5f4a887e68878f1cc3a75985194204}} 
E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+G\+ET&Next arg is backend for \hyperlink{group__kdb_ga28e385fd9cb7ccfe0b2f1ed2f62453a1}{kdb\+Get()} \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+S\+ET@{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+S\+ET}!kdbplugin.\+h@{kdbplugin.\+h}}\index{kdbplugin.\+h@{kdbplugin.\+h}!E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+S\+ET@{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+S\+ET}}}\mbox{\Hypertarget{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a85c9545261cf0bcc932616e67ea3b70a}\label{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a85c9545261cf0bcc932616e67ea3b70a}} 
E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+S\+ET&Next arg is backend for \hyperlink{group__kdb_ga11436b058408f83d303ca5e996832bcf}{kdb\+Set()} \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+E\+R\+R\+OR@{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+E\+R\+R\+OR}!kdbplugin.\+h@{kdbplugin.\+h}}\index{kdbplugin.\+h@{kdbplugin.\+h}!E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+E\+R\+R\+OR@{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+E\+R\+R\+OR}}}\mbox{\Hypertarget{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a89e027283d949dd78bb9c1fce1b19a10}\label{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a89e027283d949dd78bb9c1fce1b19a10}} 
E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+E\+R\+R\+OR&Next arg is backend for kdb\+Error() \\
\hline

\raisebox{\heightof{T}}[0pt][0pt]{\index{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+E\+ND@{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+E\+ND}!kdbplugin.\+h@{kdbplugin.\+h}}\index{kdbplugin.\+h@{kdbplugin.\+h}!E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+E\+ND@{E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+E\+ND}}}\mbox{\Hypertarget{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a64a0bc789482284d9fd27ce974e0959a}\label{kdbplugin_8h_afed89ef026fb0622918a5de020de7814a64a0bc789482284d9fd27ce974e0959a}} 
E\+L\+E\+K\+T\+R\+A\+\_\+\+P\+L\+U\+G\+I\+N\+\_\+\+E\+ND&End of arguments \\
\hline

\end{DoxyEnumFields}
