$darkmode
Elektra 0.11.0
Functions
High-level API

Functions

kdb_boolean_t checkSpec (Key *const parentKey, KeySet *contract, ElektraError **error)
 Verify that specification is properly mounted and is equal to specification at compile time. More...
 
Elektra * elektraOpen (const char *application, KeySet *defaults, KeySet *contract, ElektraError **error)
 Initializes a new Elektra instance. More...
 
void elektraFatalError (Elektra *elektra, ElektraError *fatalError)
 Promote an ElektraError to fatal and call the fatal error handler. More...
 
Key * elektraHelpKey (Elektra *elektra)
 This function is only intended for use with code-generation. More...
 
void elektraFatalErrorHandler (Elektra *elektra, ElektraErrorHandler fatalErrorHandler)
 Sets the fatal error handler that will be called, whenever a fatal error occurs. More...
 
void elektraClose (Elektra *elektra)
 Releases all resources used by the given elektra instance. More...
 
kdb_long_long_t elektraArraySize (Elektra *elektra, const char *name)
 Gets the size of an array. More...
 
Key * elektraFindArrayElementKey (Elektra *elektra, const char *name, kdb_long_long_t index, KDBType type)
 Helper function for code generation. More...
 
const char * elektraFindReferenceArrayElement (Elektra *elektra, const char *name, kdb_long_long_t index)
 Resolves the reference stored in a key. More...
 
KDBType elektraGetArrayElementType (Elektra *elektra, const char *keyname, kdb_long_long_t index)
 Reads the type metadata of a given array element. 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...
 
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...
 
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 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...
 
ElektraError * elektraErrorPureWarning (void)
 Creates a dummy ElektraError struct to store warnings in. More...
 
const char * elektraErrorCode (const ElektraError *error)
 
const char * elektraErrorDescription (const ElektraError *error)
 
void elektraErrorReset (ElektraError **error)
 Frees the memory used by the error and sets the referenced error variable to NULL.
 
Key * elektraFindKey (Elektra *elektra, const char *name, KDBType type)
 Helper function for code generation. More...
 
const char * elektraFindReference (Elektra *elektra, const char *name)
 Resolves the reference stored in a key. More...
 
KDBType elektraGetType (Elektra *elektra, const char *keyname)
 Reads the type metadata of a given key. More...
 
const char * elektraGetRawString (Elektra *elektra, const char *name)
 Get the raw string value of a key. More...
 
void elektraSetRawString (Elektra *elektra, const char *name, const char *value, KDBType type, ElektraError **error)
 Set 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 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...
 

Detailed Description

Function Documentation

◆ checkSpec()

kdb_boolean_t checkSpec ( Key *const  parentKey,
KeySet *  contract,
ElektraError **  error 
)

Verify that specification is properly mounted and is equal to specification at compile time.

Note: These checks are only executed, if the contract requires them.

Parameters
parentKeyThe parentKey of the application
contractThe contract passed to HL API by the application.
errorPointer used to report errors
Return values
Trueif the checks were successful (or not required).
Falseif the checks were required but unsuccessful.

◆ elektraArraySize()

kdb_long_long_t elektraArraySize ( Elektra *  elektra,
const char *  name 
)

Gets the size of an array.

Parameters
elektraThe Elektra instance to use.
nameThe (relative) name of the array.
Returns
the size of the array, 0 is returned if the array is empty or doesn't exist

◆ elektraClose()

void elektraClose ( Elektra *  elektra)

Releases all resources used by the given elektra instance.

The elektra instance must not be used anymore after calling this.

Parameters
elektraAn Elektra instance.

◆ elektraErrorCode()

const char* elektraErrorCode ( const ElektraError *  error)
Returns
the error code of the given error

◆ elektraErrorDescription()

const char* elektraErrorDescription ( const ElektraError *  error)
Returns
the description for the given error

◆ elektraErrorPureWarning()

ElektraError* elektraErrorPureWarning ( void  )

Creates a dummy ElektraError struct to store warnings in.

If elektraErrorCode() is called on the resulting struct, it will return NULL.

Returns
A newly allocated ElektraError (free with elektraFree()).

◆ elektraFatalError()

void elektraFatalError ( Elektra *  elektra,
ElektraError *  fatalError 
)

Promote an ElektraError to fatal and call the fatal error handler.

Parameters
elektraElektra instance whose fatal error handler shall be used.
fatalErrorThe error that will be raised.

◆ elektraFatalErrorHandler()

void elektraFatalErrorHandler ( Elektra *  elektra,
ElektraErrorHandler  fatalErrorHandler 
)

Sets the fatal error handler that will be called, whenever a fatal error occurs.

Errors occurring in a function, which does not take a pointer to ElektraError, are always considered fatal.

If this function returns, i.e. it does not call exit() or interrupt the thread of execution in some other way, the behaviour of the function from which the error originated is generally undefined.

Parameters
elektraAn Elektra instance.
fatalErrorHandlerThe error handler that will be used henceforth.

◆ elektraFindArrayElementKey()

Key * elektraFindArrayElementKey ( Elektra *  elektra,
const char *  name,
kdb_long_long_t  index,
KDBType  type 
)

Helper function for code generation.

Finds an array element Key from its relative name and index. Also checks type metadata, if type is not NULL.

Parameters
elektraThe Elektra instance to use.
nameThe relative name of the array.
indexThe index of the array element.
typeThe expected type metadata value.
Returns
the Key referenced by name or NULL, if a fatal error occurs and the fatal error handler returns to this function The returned pointer remains valid until the KeySet inside elektra is modified. Calls to elektraSet*() functions may cause such modifications. In any case, it becomes invalid when elektraClose() is called on elektra.

◆ elektraFindKey()

Key * elektraFindKey ( Elektra *  elektra,
const char *  name,
KDBType  type 
)

Helper function for code generation.

Finds a Key from its relative name. Also checks type metadata, if type is not NULL.

Parameters
elektraThe Elektra instance to use.
nameThe relative name of the key.
typeThe expected type metadata value.
Returns
the Key referenced by name or NULL, if a fatal error occurs and the fatal error handler returns to this function The returned pointer remains valid until the KeySet inside elektra is modified. Calls to elektraSet*() functions may cause such modifications. In any case, it becomes invalid when elektraClose() is called on elektra.

◆ elektraFindReference()

const char * elektraFindReference ( Elektra *  elektra,
const char *  name 
)

Resolves the reference stored in a key.

  1. Get the raw string value.
  2. Resolve that reference.
  3. Return resulting keyname relative to the parent key of the given Elektra instance.

IMPORTANT: this method DOES NOT check the type metadata of the key, it is only intended to be used by the code-generation API.

Parameters
elektraThe Elektra instance to use.
nameThe (relative) name of the key.
Returns
the resolved version of the reference stored in the specified key (relative to the parent key of elektra) or NULL, if the key was not found, or the reference resolves two a key not below the parent key. The empty string is returned, if the value was the empty string (no resolution is attempted). The returned pointer becomes invalid when this function is called again (even with the same arguments). It is also invalidated when elektraFindReferenceArrayElement() or elektraClose() are called on elektra.

◆ elektraFindReferenceArrayElement()

const char * elektraFindReferenceArrayElement ( Elektra *  elektra,
const char *  name,
kdb_long_long_t  index 
)

Resolves the reference stored in a key.

  1. Get the raw string value.
  2. Resolve that reference.
  3. Return resulting keyname relative to the parent key of the given Elektra instance.

IMPORTANT: this method DOES NOT check the type metadata of the key, it is only intended to be used by the code-generation API.

Parameters
elektraThe Elektra instance to use.
nameThe (relative) name of the array.
indexThe index of the array element.
Returns
the resolved version of the reference stored in the specified key (relative to the parent key of elektra) or NULL, if the key was not found, or the reference resolves two a key not below the parent key. The empty string is returned, if the value was the empty string (no resolution is attempted). The returned pointer becomes invalid when this function is called again (even with the same arguments). It is also invalidated when elektraFindReference() or elektraClose() are called on elektra.

◆ elektraGetArrayElementType()

KDBType elektraGetArrayElementType ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index 
)

Reads the type metadata of a given array element.

Parameters
elektraAn Elektra instance.
nameThe name of the array.
indexThe index of the array element whose type information shall be read.
Returns
the KDBType of the key

◆ elektraGetBoolean()

kdb_boolean_t elektraGetBoolean ( Elektra *  elektra,
const char *  keyname 
)

Gets a boolean value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the key to look up.
Returns
the boolean stored at the given key

◆ elektraGetBooleanArrayElement()

kdb_boolean_t elektraGetBooleanArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index 
)

Gets a boolean value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to look up.
indexThe index of the array element to look up.
Returns
the boolean stored at the given array element

◆ elektraGetChar()

kdb_char_t elektraGetChar ( Elektra *  elektra,
const char *  keyname 
)

Gets a char value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the key to look up.
Returns
the char stored at the given key

◆ elektraGetCharArrayElement()

kdb_char_t elektraGetCharArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index 
)

Gets a char value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to look up.
indexThe index of the array element to look up.
Returns
the char stored at the given array element

◆ elektraGetDouble()

kdb_double_t elektraGetDouble ( Elektra *  elektra,
const char *  keyname 
)

Gets a double value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the key to look up.
Returns
the double stored at the given key

◆ elektraGetDoubleArrayElement()

kdb_double_t elektraGetDoubleArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index 
)

Gets a double value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to look up.
indexThe index of the array element to look up.
Returns
the double stored at the given array element

◆ elektraGetFloat()

kdb_float_t elektraGetFloat ( Elektra *  elektra,
const char *  keyname 
)

Gets a float value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the key to look up.
Returns
the float stored at the given key

◆ elektraGetFloatArrayElement()

kdb_float_t elektraGetFloatArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index 
)

Gets a float value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to look up.
indexThe index of the array element to look up.
Returns
the float stored at the given array element

◆ elektraGetLong()

kdb_long_t elektraGetLong ( Elektra *  elektra,
const char *  keyname 
)

Gets a long value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the key to look up.
Returns
the long stored at the given key

◆ elektraGetLongArrayElement()

kdb_long_t elektraGetLongArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index 
)

Gets a long value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to look up.
indexThe index of the array element to look up.
Returns
the long stored at the given array element

◆ elektraGetLongLong()

kdb_long_long_t elektraGetLongLong ( Elektra *  elektra,
const char *  keyname 
)

Gets a long long value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the key to look up.
Returns
the long long stored at the given key

◆ elektraGetLongLongArrayElement()

kdb_long_long_t elektraGetLongLongArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index 
)

Gets a long long value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to look up.
indexThe index of the array element to look up.
Returns
the long long stored at the given array element

◆ elektraGetOctet()

kdb_octet_t elektraGetOctet ( Elektra *  elektra,
const char *  keyname 
)

Gets an octet value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the key to look up.
Returns
the octet stored at the given key

◆ elektraGetOctetArrayElement()

kdb_octet_t elektraGetOctetArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index 
)

Gets an octet value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to look up.
indexThe index of the array element to look up.
Returns
the octet stored at the given array element

◆ elektraGetRawString()

const char * elektraGetRawString ( Elektra *  elektra,
const char *  name 
)

Get the raw string value of a key.

Parameters
elektraThe Elektra instance to use.
nameThe (relative) name of the key.
Returns
the raw value of the specified key or NULL, if the key was not found The returned pointer remains valid until the internal state of elektra is modified. Calls to elektraSet*() functions may cause such modifications. In any case, it becomes invalid when elektraClose() is called on elektra.

◆ elektraGetRawStringArrayElement()

const char * elektraGetRawStringArrayElement ( Elektra *  elektra,
const char *  name,
kdb_long_long_t  index 
)

Get the raw string value of an array element key.

Parameters
elektraThe Elektra instance to use.
nameThe (relative) name of the array.
indexThe index of the array element.
Returns
the raw value of the specified key, or NULL if the key was not found The returned pointer remains valid until the internal state of elektra is modified. Calls to elektraSet*() functions may cause such modifications. In any case, it becomes invalid when elektraClose() is called on elektra.

◆ elektraGetShort()

kdb_short_t elektraGetShort ( Elektra *  elektra,
const char *  keyname 
)

Gets a short value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the key to look up.
Returns
the short stored at the given key

◆ elektraGetShortArrayElement()

kdb_short_t elektraGetShortArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index 
)

Gets a short value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to look up.
indexThe index of the array element to look up.
Returns
the short stored at the given array element

◆ elektraGetString()

const char * elektraGetString ( Elektra *  elektra,
const char *  keyname 
)

Gets a string value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the key to look up.
Returns
the string stored at the given key The returned pointer remains valid until the internal state of elektra is modified. Calls to elektraSet*() functions may cause such modifications. In any case, it becomes invalid when elektraClose() is called on elektra.

◆ elektraGetStringArrayElement()

const char * elektraGetStringArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index 
)

Gets a string value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to look up.
indexThe index of the array element to look up.
Returns
the string stored at the given array element The returned pointer remains valid until the internal state of elektra is modified. Calls to elektraSet*() functions may cause such modifications. In any case, it becomes invalid when elektraClose() is called on elektra.

◆ elektraGetType()

KDBType elektraGetType ( Elektra *  elektra,
const char *  keyname 
)

Reads the type metadata of a given key.

Parameters
elektraAn Elektra instance.
keynameThe name of the key whose type information shall be read.
Returns
the KDBType of the key

◆ elektraGetUnsignedLong()

kdb_unsigned_long_t elektraGetUnsignedLong ( Elektra *  elektra,
const char *  keyname 
)

Gets a unsigned long value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the key to look up.
Returns
the unsigned long stored at the given key

◆ elektraGetUnsignedLongArrayElement()

kdb_unsigned_long_t elektraGetUnsignedLongArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index 
)

Gets a unsigned long value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to look up.
indexThe index of the array element to look up.
Returns
the unsigned long stored at the given array element

◆ elektraGetUnsignedLongLong()

kdb_unsigned_long_long_t elektraGetUnsignedLongLong ( Elektra *  elektra,
const char *  keyname 
)

Gets a long long value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the key to look up.
Returns
the unsigned long long stored at the given key

◆ elektraGetUnsignedLongLongArrayElement()

kdb_unsigned_long_long_t elektraGetUnsignedLongLongArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index 
)

Gets a unsigned long long value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to look up.
indexThe index of the array element to look up.
Returns
the unsigned long long stored at the given array element

◆ elektraGetUnsignedShort()

kdb_unsigned_short_t elektraGetUnsignedShort ( Elektra *  elektra,
const char *  keyname 
)

Gets a unsigned short value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the key to look up.
Returns
the unsigned short stored at the given key

◆ elektraGetUnsignedShortArrayElement()

kdb_unsigned_short_t elektraGetUnsignedShortArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index 
)

Gets a unsigned short value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to look up.
indexThe index of the array element to look up.
Returns
the unsigned short stored at the given array element

◆ elektraHelpKey()

Key * elektraHelpKey ( Elektra *  elektra)

This function is only intended for use with code-generation.

It looks for the key proc:/elektra/gopts/help (absolute name) created by gopts, and returns it if found.

Parameters
elektraThe Elektra instance to check
Returns
the help key if found, NULL otherwise The pointer returned may become invalid, when any elektraSet*() function or any other function that modifies the state of elektra is called. It will always become invalid, when elektraClose() is called on elektra.

◆ elektraOpen()

Elektra * elektraOpen ( const char *  application,
KeySet *  defaults,
KeySet *  contract,
ElektraError **  error 
)

Initializes a new Elektra instance.

To free the memory allocated by this function call elektraClose(), once you are done using this instance.

Parameters
applicationYour application's base name. The simplest version for this string is "/sw/org/<appname>/#0/current", where '<appname>' is a unique name for your application. For more information see the man-page elektra-key-names(7).
defaultsA KeySet containing default values. If you pass NULL, trying to read a non-existent value will cause a fatal error. It is recommended, to only pass NULL, if you are using a specification, which provides default values inside of the KDB. If a key in this KeySet doesn't have a value, we will use the value of the "default" metakey of this key.
contractWill be passed to kdbOpen() as the contract.
errorIf an error occurs during initialization of the Elektra instance, this pointer will be used to report the error.
Returns
An Elektra instance initialized for the application (free with elektraClose()).
See also
elektraClose
kdbOpen

◆ elektraSetBoolean()

void elektraSetBoolean ( Elektra *  elektra,
const char *  keyname,
kdb_boolean_t  value,
ElektraError **  error 
)

Sets a boolean value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name to write to.
valueThe new boolean value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetBooleanArrayElement()

void elektraSetBooleanArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index,
kdb_boolean_t  value,
ElektraError **  error 
)

Sets a boolean value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to write to.
indexThe index of the array element to write to.
valueThe new boolean value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetChar()

void elektraSetChar ( Elektra *  elektra,
const char *  keyname,
kdb_char_t  value,
ElektraError **  error 
)

Sets a char value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name to write to.
valueThe new char value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetCharArrayElement()

void elektraSetCharArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index,
kdb_char_t  value,
ElektraError **  error 
)

Sets a char value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to write to.
indexThe index of the array element to write to.
valueThe new char value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetDouble()

void elektraSetDouble ( Elektra *  elektra,
const char *  keyname,
kdb_double_t  value,
ElektraError **  error 
)

Sets a double value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name to write to.
valueThe new double value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetDoubleArrayElement()

void elektraSetDoubleArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index,
kdb_double_t  value,
ElektraError **  error 
)

Sets a double value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to write to.
indexThe index of the array element to write to.
valueThe new double value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetFloat()

void elektraSetFloat ( Elektra *  elektra,
const char *  keyname,
kdb_float_t  value,
ElektraError **  error 
)

Sets a float value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name to write to.
valueThe new float value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetFloatArrayElement()

void elektraSetFloatArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index,
kdb_float_t  value,
ElektraError **  error 
)

Sets a float value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to write to.
indexThe index of the array element to write to.
valueThe new float value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetLong()

void elektraSetLong ( Elektra *  elektra,
const char *  keyname,
kdb_long_t  value,
ElektraError **  error 
)

Sets a long value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name to write to.
valueThe new long value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetLongArrayElement()

void elektraSetLongArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index,
kdb_long_t  value,
ElektraError **  error 
)

Sets a long value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to write to.
indexThe index of the array element to write to.
valueThe new long value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetLongLong()

void elektraSetLongLong ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  value,
ElektraError **  error 
)

Sets a long long value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name to write to.
valueThe new long long value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetLongLongArrayElement()

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.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to write to.
indexThe index of the array element to write to.
valueThe new long long value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetOctet()

void elektraSetOctet ( Elektra *  elektra,
const char *  keyname,
kdb_octet_t  value,
ElektraError **  error 
)

Sets an octet value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name to write to.
valueThe new octet value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetOctetArrayElement()

void elektraSetOctetArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index,
kdb_octet_t  value,
ElektraError **  error 
)

Sets an octet value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to write to.
indexThe index of the array element to write to.
valueThe new octet value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetRawString()

void elektraSetRawString ( Elektra *  elektra,
const char *  name,
const char *  value,
KDBType  type,
ElektraError **  error 
)

Set the raw string value of a key.

Parameters
elektraThe Elektra instance to use.
nameThe (relative) name of the key.
valueThe raw value to set.
typeThe type to set in the metadata of the key.
errorPointer to an ElektraError. Will be set in case saving fails.

◆ elektraSetRawStringArrayElement()

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.

Parameters
elektraThe Elektra instance to use.
nameThe (relative) name of the array.
indexThe index of the array element.
valueThe raw value to set.
typeThe type to set in the metadata of the (array element) key.
errorPointer to an ElektraError. Will be set in case saving fails.

◆ elektraSetShort()

void elektraSetShort ( Elektra *  elektra,
const char *  keyname,
kdb_short_t  value,
ElektraError **  error 
)

Sets a short value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name to write to.
valueThe new short value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetShortArrayElement()

void elektraSetShortArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index,
kdb_short_t  value,
ElektraError **  error 
)

Sets a short value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to write to.
indexThe index of the array element to write to.
valueThe new short value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetString()

void elektraSetString ( Elektra *  elektra,
const char *  keyname,
const char *  value,
ElektraError **  error 
)

Sets a string value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name to write to.
valueThe new string value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetStringArrayElement()

void elektraSetStringArrayElement ( Elektra *  elektra,
const char *  keyname,
kdb_long_long_t  index,
const char *  value,
ElektraError **  error 
)

Sets a string value array element.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to write to.
indexThe index of the array element to write to.
valueThe new string value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetUnsignedLong()

void elektraSetUnsignedLong ( Elektra *  elektra,
const char *  keyname,
kdb_unsigned_long_t  value,
ElektraError **  error 
)

Sets a unsigned long value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name to write to.
valueThe new unsigned long value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetUnsignedLongArrayElement()

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.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to write to.
indexThe index of the array element to write to.
valueThe new unsigned long value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetUnsignedLongLong()

void elektraSetUnsignedLongLong ( Elektra *  elektra,
const char *  keyname,
kdb_unsigned_long_long_t  value,
ElektraError **  error 
)

Sets a unsigned long long value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name to write to.
valueThe new unsigned long long value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetUnsignedLongLongArrayElement()

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.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to write to.
indexThe index of the array element to write to.
valueThe new unsigned long long value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetUnsignedShort()

void elektraSetUnsignedShort ( Elektra *  elektra,
const char *  keyname,
kdb_unsigned_short_t  value,
ElektraError **  error 
)

Sets a unsigned short value.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name to write to.
valueThe new unsigned short value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.

◆ elektraSetUnsignedShortArrayElement()

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.

Parameters
elektraThe elektra instance to use.
keynameThe (relative) name of the array to write to.
indexThe index of the array element to write to.
valueThe new unsigned short value.
errorPass a reference to an ElektraError pointer. Will only be set in case of an error.