\hypertarget{doc_8h}{}\section{doc.\+h File Reference}
\label{doc_8h}\index{doc.\+h@{doc.\+h}}
{\ttfamily \#include $<$kdbplugin.\+h$>$}\newline
Include dependency graph for doc.\+h\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{doc_8h__incl}
\end{center}
\end{figure}
\subsection*{Macros}
\begin{DoxyCompactItemize}
\item 
\#define \hyperlink{group__plugin_gaab1842b82272e6d4235b6a71587a64d9}{E\+L\+E\+K\+T\+R\+A\+\_\+\+S\+E\+T\+\_\+\+E\+R\+R\+OR}(number,  key,  text)
\begin{DoxyCompactList}\small\item\em Sets the error in the keys metadata. \end{DoxyCompactList}\item 
\#define \hyperlink{group__plugin_ga3e4fc2c20d8e64bed7a54bb1af882e34}{E\+L\+E\+K\+T\+R\+A\+\_\+\+S\+E\+T\+\_\+\+E\+R\+R\+O\+RF}(number,  key,  formatstring, ...)
\begin{DoxyCompactList}\small\item\em Sets the error in the keys metadata. \end{DoxyCompactList}\item 
\#define \hyperlink{group__plugin_ga2bbb3bc3a3bdaf5b34b52de81886a098}{E\+L\+E\+K\+T\+R\+A\+\_\+\+A\+D\+D\+\_\+\+W\+A\+R\+N\+I\+N\+GF}(number,  key,  formatstring, ...)
\begin{DoxyCompactList}\small\item\em Adds a warning in the keys metadata. \end{DoxyCompactList}\item 
\#define \hyperlink{group__plugin_ga3da3bdb0f41710adda9eee3d7adac9ff}{E\+L\+E\+K\+T\+R\+A\+\_\+\+A\+D\+D\+\_\+\+W\+A\+R\+N\+I\+NG}(number,  key,  text)
\begin{DoxyCompactList}\small\item\em Adds a warning in the keys metadata. \end{DoxyCompactList}\item 
\#define \hyperlink{group__plugin_ga2f5d331ed725c6af0c511a0aa8677daa}{E\+L\+E\+K\+T\+R\+A\+\_\+\+S\+E\+T\+\_\+\+E\+R\+R\+O\+R\+\_\+\+G\+ET}(parent\+Key)
\begin{DoxyCompactList}\small\item\em Set error in \hyperlink{group__kdb_ga28e385fd9cb7ccfe0b2f1ed2f62453a1}{kdb\+Get()} when opening the file failed. \end{DoxyCompactList}\item 
\#define \hyperlink{group__plugin_gaf526686f01dbacd68671732aad4b5d76}{E\+L\+E\+K\+T\+R\+A\+\_\+\+S\+E\+T\+\_\+\+E\+R\+R\+O\+R\+\_\+\+S\+ET}(parent\+Key)
\begin{DoxyCompactList}\small\item\em Set error in \hyperlink{group__kdb_ga11436b058408f83d303ca5e996832bcf}{kdb\+Set()} when opening the file failed. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
int \hyperlink{group__plugin_ga23c2eb3584e38a4d494eb8f91e5e3d8d}{elektra\+Doc\+Open} (Plugin $\ast$handle, Key $\ast$warnings\+Key)
\begin{DoxyCompactList}\small\item\em Initialize data for the plugin. \end{DoxyCompactList}\item 
int \hyperlink{group__plugin_ga1236aefe5b2baf8b7bf636ba5aa9ea29}{elektra\+Doc\+Close} (Plugin $\ast$handle, Key $\ast$warnings\+Key)
\begin{DoxyCompactList}\small\item\em Finalize the plugin. \end{DoxyCompactList}\item 
int \hyperlink{group__plugin_gacb69f3441c6d84241b4362f958fbe313}{elektra\+Doc\+Get} (Plugin $\ast$handle, Key\+Set $\ast$returned, Key $\ast$parent\+Key)
\begin{DoxyCompactList}\small\item\em Get data from storage to application. \end{DoxyCompactList}\item 
int \hyperlink{group__plugin_gae65781a1deb34efc79c8cb9d9174842c}{elektra\+Doc\+Set} (Plugin $\ast$handle, Key\+Set $\ast$returned, Key $\ast$parent\+Key)
\begin{DoxyCompactList}\small\item\em Set data from application to storage. \end{DoxyCompactList}\item 
int \hyperlink{group__plugin_gad74b35f558ac7c3262f6069c5c47dc79}{elektra\+Doc\+Error} (Plugin $\ast$handle, Key\+Set $\ast$returned, Key $\ast$parent\+Key)
\begin{DoxyCompactList}\small\item\em Rollback in case of errors. \end{DoxyCompactList}\item 
int \hyperlink{group__plugin_ga1c8702efe0f3853c2d7ecca0889f78e8}{elektra\+Doc\+Check\+Conf} (Key $\ast$error\+Key, Key\+Set $\ast$conf)
\begin{DoxyCompactList}\small\item\em Validate plugin configuration at mount time. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
\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}
