Elektra  0.9.8
Functions
elektra.h File Reference

Elektra High Level API. More...

#include <elektra/error.h>
#include <elektra/types.h>
#include <kdb.h>
#include <kdbmacros.h>
#include <kdbtypes.h>
Include dependency graph for elektra.h:
This graph shows which files directly or indirectly include this file:

Functions

Elektra * elektraOpen (const char *application, KeySet *defaults, KeySet *contract, ElektraError **error)
 Initializes a new Elektra instance. More...
 
void elektraClose (Elektra *elektra)
 Releases all resources used by the given elektra instance. More...
 
void elektraFatalErrorHandler (Elektra *elektra, ElektraErrorHandler fatalErrorHandler)
 Sets the fatal error handler that will be called, whenever a fatal error occurs. More...
 
Key * elektraFindKey (Elektra *elektra, const char *name, KDBType type)
 Helper function for code generation. More...
 
Key * elektraFindArrayElementKey (Elektra *elektra, const char *name, kdb_long_long_t index, KDBType type)
 Helper function for code generation. More...
 
void elektraFatalError (Elektra *elektra, ElektraError *fatalError)
 Promote an ElektraError to fatal and call the fatal error handler. More...
 
const char * elektraFindReference (Elektra *elektra, const char *name)
 Resolves the reference stored in a key. More...
 
const char * elektraFindReferenceArrayElement (Elektra *elektra, const char *name, kdb_long_long_t index)
 Resolves the reference stored in a key. More...
 
Key * elektraHelpKey (Elektra *elektra)
 This function is only intended for use with code-generation. More...
 
const char * elektraGetRawString (Elektra *elektra, const char *name)
 Get the raw string value of a key. More...
 
const char * elektraGetString (Elektra *elektra, const char *keyname)
 Gets a string value. More...
 
kdb_boolean_t elektraGetBoolean (Elektra *elektra, const char *keyname)
 Gets a boolean value. More...
 
kdb_char_t elektraGetChar (Elektra *elektra, const char *keyname)
 Gets a char value. More...
 
kdb_octet_t elektraGetOctet (Elektra *elektra, const char *keyname)
 Gets an octet value. More...
 
kdb_short_t elektraGetShort (Elektra *elektra, const char *keyname)
 Gets a short value. More...
 
kdb_unsigned_short_t elektraGetUnsignedShort (Elektra *elektra, const char *keyname)
 Gets a unsigned short value. More...
 
kdb_long_t elektraGetLong (Elektra *elektra, const char *keyname)
 Gets a long value. More...
 
kdb_unsigned_long_t elektraGetUnsignedLong (Elektra *elektra, const char *keyname)
 Gets a unsigned long value. More...
 
kdb_long_long_t elektraGetLongLong (Elektra *elektra, const char *keyname)
 Gets a long long value. More...
 
kdb_unsigned_long_long_t elektraGetUnsignedLongLong (Elektra *elektra, const char *keyname)
 Gets a long long value. More...
 
kdb_float_t elektraGetFloat (Elektra *elektra, const char *keyname)
 Gets a float value. More...
 
kdb_double_t elektraGetDouble (Elektra *elektra, const char *keyname)
 Gets a double value. More...
 
void elektraSetRawString (Elektra *elektra, const char *name, const char *value, KDBType type, ElektraError **error)
 Set the raw string value of a key. More...
 
void elektraSetString (Elektra *elektra, const char *keyname, const char *value, ElektraError **error)
 Sets a string value. More...
 
void elektraSetBoolean (Elektra *elektra, const char *keyname, kdb_boolean_t value, ElektraError **error)
 Sets a boolean value. More...
 
void elektraSetChar (Elektra *elektra, const char *keyname, kdb_char_t value, ElektraError **error)
 Sets a char value. More...
 
void elektraSetOctet (Elektra *elektra, const char *keyname, kdb_octet_t value, ElektraError **error)
 Sets an octet value. More...
 
void elektraSetShort (Elektra *elektra, const char *keyname, kdb_short_t value, ElektraError **error)
 Sets a short value. More...
 
void elektraSetUnsignedShort (Elektra *elektra, const char *keyname, kdb_unsigned_short_t value, ElektraError **error)
 Sets a unsigned short value. More...
 
void elektraSetLong (Elektra *elektra, const char *keyname, kdb_long_t value, ElektraError **error)
 Sets a long value. More...
 
void elektraSetUnsignedLong (Elektra *elektra, const char *keyname, kdb_unsigned_long_t value, ElektraError **error)
 Sets a unsigned long value. More...
 
void elektraSetLongLong (Elektra *elektra, const char *keyname, kdb_long_long_t value, ElektraError **error)
 Sets a long long value. More...
 
void elektraSetUnsignedLongLong (Elektra *elektra, const char *keyname, kdb_unsigned_long_long_t value, ElektraError **error)
 Sets a unsigned long long value. More...
 
void elektraSetFloat (Elektra *elektra, const char *keyname, kdb_float_t value, ElektraError **error)
 Sets a float value. More...
 
void elektraSetDouble (Elektra *elektra, const char *keyname, kdb_double_t value, ElektraError **error)
 Sets a double value. More...
 
kdb_long_long_t elektraArraySize (Elektra *elektra, const char *name)
 Gets the size of an array. More...
 
const char * elektraGetRawStringArrayElement (Elektra *elektra, const char *name, kdb_long_long_t index)
 Get the raw string value of an array element key. More...
 
const char * elektraGetStringArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Gets a string value array element. More...
 
kdb_boolean_t elektraGetBooleanArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Gets a boolean value array element. More...
 
kdb_char_t elektraGetCharArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Gets a char value array element. More...
 
kdb_octet_t elektraGetOctetArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Gets an octet value array element. More...
 
kdb_short_t elektraGetShortArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Gets a short value array element. More...
 
kdb_unsigned_short_t elektraGetUnsignedShortArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Gets a unsigned short value array element. More...
 
kdb_long_t elektraGetLongArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Gets a long value array element. More...
 
kdb_unsigned_long_t elektraGetUnsignedLongArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Gets a unsigned long value array element. More...
 
kdb_long_long_t elektraGetLongLongArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Gets a long long value array element. More...
 
kdb_unsigned_long_long_t elektraGetUnsignedLongLongArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Gets a unsigned long long value array element. More...
 
kdb_float_t elektraGetFloatArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Gets a float value array element. More...
 
kdb_double_t elektraGetDoubleArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Gets a double value array element. More...
 
void elektraSetRawStringArrayElement (Elektra *elektra, const char *name, kdb_long_long_t index, const char *value, KDBType type, ElektraError **error)
 Set the raw string value of an array element key. More...
 
void elektraSetStringArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index, const char *value, ElektraError **error)
 Sets a string value array element. More...
 
void elektraSetBooleanArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index, kdb_boolean_t value, ElektraError **error)
 Sets a boolean value array element. More...
 
void elektraSetCharArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index, kdb_char_t value, ElektraError **error)
 Sets a char value array element. More...
 
void elektraSetOctetArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index, kdb_octet_t value, ElektraError **error)
 Sets an octet value array element. More...
 
void elektraSetShortArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index, kdb_short_t value, ElektraError **error)
 Sets a short value array element. More...
 
void elektraSetUnsignedShortArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index, kdb_unsigned_short_t value, ElektraError **error)
 Sets a unsigned short value array element. More...
 
void elektraSetLongArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index, kdb_long_t value, ElektraError **error)
 Sets a long value array element. More...
 
void elektraSetUnsignedLongArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index, kdb_unsigned_long_t value, ElektraError **error)
 Sets a unsigned long value array element. More...
 
void elektraSetLongLongArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index, kdb_long_long_t value, ElektraError **error)
 Sets a long long value array element. More...
 
void elektraSetUnsignedLongLongArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index, kdb_unsigned_long_long_t value, ElektraError **error)
 Sets a unsigned long long value array element. More...
 
void elektraSetFloatArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index, kdb_float_t value, ElektraError **error)
 Sets a float value array element. More...
 
void elektraSetDoubleArrayElement (Elektra *elektra, const char *keyname, kdb_long_long_t index, kdb_double_t value, ElektraError **error)
 Sets a double value array element. More...
 
KDBType elektraGetType (Elektra *elektra, const char *keyname)
 Reads the type metadata of a given key. More...
 
KDBType elektraGetArrayElementType (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Reads the type metadata of a given array element. More...
 

Detailed Description

Elektra High Level API.