.TH "plugin.c" 3elektra "Fri Aug 4 2023" "Version 0.11.0" "Elektra" \" -*- nroff -*-
.ad l
.nh
.SH NAME
plugin.c \- Interna of plugin functionality\&.  

.SH SYNOPSIS
.br
.PP
\fC#include <kdbassert\&.h>\fP
.br
\fC#include <kdberrors\&.h>\fP
.br
\fC#include <kdbinternal\&.h>\fP
.br
\fC#include <kdbversion\&.h>\fP
.br

.SS "Functions"

.in +1c
.ti -1c
.RI "Plugin * \fBelektraPluginOpen\fP (const char *name, KeySet *modules, KeySet *config, Key *errorKey)"
.br
.RI "Opens a plugin\&. "
.ti -1c
.RI "size_t \fBelektraPluginGetFunction\fP (Plugin *plugin, const char *name)"
.br
.RI "Retrieves a function exported by a plugin\&. "
.ti -1c
.RI "const char * \fBelektraPluginPhaseName\fP (ElektraKdbPhase phase)"
.br
.RI "Gets a string with the name of the given constant for a plugin phase\&. "
.in -1c
.SH "Detailed Description"
.PP 
Interna of plugin functionality\&. 


.PP
\fBCopyright\fP
.RS 4
BSD License (see LICENSE\&.md or https://www.libelektra.org) 
.RE
.PP

.SH "Function Documentation"
.PP 
.SS "size_t elektraPluginGetFunction (Plugin * plugin, const char * name)"

.PP
Retrieves a function exported by a plugin\&. 
.PP
\fBParameters\fP
.RS 4
\fIplugin\fP Plugin handle 
.br
\fIname\fP Function name\&. Must be a valid key name suffix\&. May not contain the sequence '\&.\&.' 
.RE
.PP
\fBReturns\fP
.RS 4
Pointer to function\&. NULL if function not found or not enough memory available 
.RE
.PP

.SS "Plugin* elektraPluginOpen (const char * name, KeySet * modules, KeySet * config, Key * errorKey)"

.PP
Opens a plugin\&. The config will be used as is\&. So be sure to transfer ownership of the config to it, with e\&.g\&. \fBksDup()\fP\&. elektraPluginClose() will delete the config\&.
.PP
\fBReturns\fP
.RS 4
a pointer to a new created plugin or 0 on error 
.RE
.PP

.SS "const char* elektraPluginPhaseName (ElektraKdbPhase phase)"

.PP
Gets a string with the name of the given constant for a plugin phase\&. 
.PP
\fBParameters\fP
.RS 4
\fIphase\fP The ElektraKdbPhase value for which a string representation should be returned
.RE
.PP
\fBReturns\fP
.RS 4
A string with the name of the given phase\&. The returned string is a constant value and must never be freed! 
.RE
.PP
\fBReturn values\fP
.RS 4
\fI???\fP if an unknown value for the phase was given 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for Elektra from the source code\&.