\hypertarget{plugin_2plugin_8c}{}\doxysection{plugin.\+c File Reference}
\label{plugin_2plugin_8c}\index{plugin.c@{plugin.c}}


Access plugin handle.  


{\ttfamily \#include $<$kdbassert.\+h$>$}\newline
{\ttfamily \#include $<$kdbinternal.\+h$>$}\newline
Include dependency graph for plugin/plugin.c\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{plugin_2plugin_8c__incl}
\end{center}
\end{figure}
\doxysubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
Plugin $\ast$ \mbox{\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$ \mbox{\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 \mbox{\hyperlink{group__plugin_gaf4b941a52ff55d0ca2a9158d90208ef2}{elektra\+Plugin\+Set\+Data}} (Plugin $\ast$plugin, void $\ast$data)
\begin{DoxyCompactList}\small\item\em Store a pointer to plugin specific data. \end{DoxyCompactList}\item 
void $\ast$ \mbox{\hyperlink{group__plugin_gaafcf3216b46292f222b8cc7828b4dd20}{elektra\+Plugin\+Get\+Data}} (Plugin $\ast$plugin)
\begin{DoxyCompactList}\small\item\em Get a pointer to the plugin specific data stored before. \end{DoxyCompactList}\item 
Key\+Set $\ast$ \mbox{\hyperlink{group__plugin_ga436cda13ed70c0face08661a90620bf6}{elektra\+Plugin\+Get\+Global\+Key\+Set}} (Plugin $\ast$plugin)
\begin{DoxyCompactList}\small\item\em Get a pointer to the global keyset. \end{DoxyCompactList}\item 
Elektra\+Kdb\+Phase \mbox{\hyperlink{plugin_2plugin_8c_a106648a1b249c4fd7bedded220b4f928}{elektra\+Plugin\+Get\+Phase}} (Plugin $\ast$plugin)
\begin{DoxyCompactList}\small\item\em Returns the current phase of the current KDB operation. \end{DoxyCompactList}\item 
Plugin $\ast$ \mbox{\hyperlink{plugin_2plugin_8c_a4c62dbd6b89b65ec734ead32ec358680}{elektra\+Plugin\+From\+Mountpoint}} (Plugin $\ast$plugin, const char $\ast$ref)
\begin{DoxyCompactList}\small\item\em Retrieves the handle for another plugin in the same mountpoint based on a reference. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Access plugin handle. 

\begin{DoxyCopyright}{Copyright}
BSD License (see LICENSE.\+md or \href{https://www.libelektra.org}{\texttt{ https\+://www.\+libelektra.\+org}}) 
\end{DoxyCopyright}


\doxysubsection{Function Documentation}
\mbox{\Hypertarget{plugin_2plugin_8c_a4c62dbd6b89b65ec734ead32ec358680}\label{plugin_2plugin_8c_a4c62dbd6b89b65ec734ead32ec358680}} 
\index{plugin/plugin.c@{plugin/plugin.c}!elektraPluginFromMountpoint@{elektraPluginFromMountpoint}}
\index{elektraPluginFromMountpoint@{elektraPluginFromMountpoint}!plugin/plugin.c@{plugin/plugin.c}}
\doxysubsubsection{\texorpdfstring{elektraPluginFromMountpoint()}{elektraPluginFromMountpoint()}}
{\footnotesize\ttfamily Plugin$\ast$ elektra\+Plugin\+From\+Mountpoint (\begin{DoxyParamCaption}\item[{Plugin $\ast$}]{plugin,  }\item[{const char $\ast$}]{ref }\end{DoxyParamCaption})}



Retrieves the handle for another plugin in the same mountpoint based on a reference. 

The plugins of a mountpoint are defined via {\ttfamily system\+:/elektra/mountpoint/$<$mp$>$/pluigns/$<$ref$>$} keys in the declaration of the mountpoint. To use this function, you must provide the {\ttfamily $<$ref$>$} part as {\ttfamily ref}.


\begin{DoxyParams}{Parameters}
{\em plugin} & active plugin handle \\
\hline
{\em ref} & reference to another plugin \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
the plugin referenced by {\ttfamily ref} 
\end{DoxyReturn}

\begin{DoxyRetVals}{Return values}
{\em NULL} & if {\ttfamily plugin}, or {\ttfamily ref} are {\ttfamily NULL}, or no plugin was found for {\ttfamily ref} \\
\hline
\end{DoxyRetVals}
\mbox{\Hypertarget{plugin_2plugin_8c_a106648a1b249c4fd7bedded220b4f928}\label{plugin_2plugin_8c_a106648a1b249c4fd7bedded220b4f928}} 
\index{plugin/plugin.c@{plugin/plugin.c}!elektraPluginGetPhase@{elektraPluginGetPhase}}
\index{elektraPluginGetPhase@{elektraPluginGetPhase}!plugin/plugin.c@{plugin/plugin.c}}
\doxysubsubsection{\texorpdfstring{elektraPluginGetPhase()}{elektraPluginGetPhase()}}
{\footnotesize\ttfamily Elektra\+Kdb\+Phase elektra\+Plugin\+Get\+Phase (\begin{DoxyParamCaption}\item[{Plugin $\ast$}]{plugin }\end{DoxyParamCaption})}



Returns the current phase of the current KDB operation. 

During \mbox{\hyperlink{group__kdb_ga28e385fd9cb7ccfe0b2f1ed2f62453a1}{kdb\+Get()}} this will be one of the {\ttfamily ELEKTRA\+\_\+\+KDB\+\_\+\+GET\+\_\+\+PHASE\+\_\+$\ast$} constants and during \mbox{\hyperlink{group__kdb_ga11436b058408f83d303ca5e996832bcf}{kdb\+Set()}} it will be one of the {\ttfamily ELEKTRA\+\_\+\+KDB\+\_\+\+SET\+\_\+\+PHASE\+\_\+$\ast$} constants.


\begin{DoxyParams}{Parameters}
{\em plugin} & plugin handle \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
current phase 
\end{DoxyReturn}

\begin{DoxyRetVals}{Return values}
{\em 0} & if {\ttfamily plugin} is {\ttfamily NULL} \\
\hline
\end{DoxyRetVals}
