Access plugin handle. More...

#include <kdbassert.h>
#include <kdbinternal.h>

Include dependency graph for plugin/plugin.c:

Functions
Plugin *	elektraPluginExport (const char *pluginName,...)
	Allows one to Export Methods for a Plugin. More...

KeySet *	elektraPluginGetConfig (Plugin *handle)
	Returns the configuration of that plugin. More...

void	elektraPluginSetData (Plugin plugin, void data)
	Store a pointer to plugin specific data. More...

void *	elektraPluginGetData (Plugin *plugin)
	Get a pointer to the plugin specific data stored before. More...

KeySet *	elektraPluginGetGlobalKeySet (Plugin *plugin)
	Get a pointer to the global keyset. More...

ElektraKdbPhase	elektraPluginGetPhase (Plugin *plugin)
	Returns the current phase of the current KDB operation. More...

Plugin *	elektraPluginFromMountpoint (Plugin plugin, const char ref)
	Retrieves the handle for another plugin in the same mountpoint based on a reference. More...

Detailed Description

Access plugin handle.

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

Function Documentation

◆ elektraPluginFromMountpoint()

Plugin* elektraPluginFromMountpoint	(	Plugin *	plugin,
		const char *	ref
	)

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

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

Parameters

plugin	active plugin handle
ref	reference to another plugin

Returns: the plugin referenced by ref

Return values

NULL	if `plugin`, or `ref` are `NULL`, or no plugin was found for `ref`

◆ elektraPluginGetPhase()

ElektraKdbPhase elektraPluginGetPhase ( Plugin * plugin )

Returns the current phase of the current KDB operation.

During kdbGet() this will be one of the ELEKTRA_KDB_GET_PHASE_* constants and during kdbSet() it will be one of the ELEKTRA_KDB_SET_PHASE_* constants.