Elektra
0.8.26
|
Macros | |
#define | ELEKTRA_TAG_DECLARATIONS(cType, typeName) |
Inserts the necessary declarations for a new Elektra Tag that can be used in combination with the generic getter and setter macros. More... | |
#define | ELEKTRA_TAG_DEFINITIONS(cType, typeName, KDB_TYPE, VALUE_TO_STRING, KEY_TO_VALUE) |
Inserts the necessary definitions for an Elektra Tag declared with ELEKTRA_TAG_DECLARATIONS. More... | |
#define | ELEKTRA_TAG_VALUE(tagName, keyname, typeName) |
Inserts a new static instance of an Elektra Tag. More... | |
#define | elektraGet(elektra, tag) ((tag).get (elektra, &(tag))) |
#define | elektraGetArrayElement(elektra, tag, index) ((tag).getArrayElement (elektra, &(tag), index)) |
#define | elektraSet(elektra, tag, value, error) ((tag).set (elektra, &(tag), value, error)) |
#define | elektraSetArrayElement(elektra, tag, index, value, error) ((tag).setArrayElement (elektra, &(tag), index, value, error)) |
Functions | |
void | elektraFatalError (Elektra *elektra, ElektraError *fatalError) |
Promote an ElektraError to fatal and call the fatal error handler. 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... | |
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 a 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 a 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... | |
ElektraErrorCode | elektraErrorCode (const ElektraError *error) |
const char * | elektraErrorDescription (const ElektraError *error) |
ElektraErrorSeverity | elektraErrorSeverity (const ElektraError *error) |
int | elektraKDBErrorCode (const ElektraError *error) |
const char * | elektraKDBErrorDescription (const ElektraError *error) |
ElektraErrorSeverity | elektraKDBErrorSeverity (const ElektraError *error) |
ElektraKDBErrorGroup | elektraKDBErrorGroup (const ElektraError *error) |
ElektraKDBErrorModule | elektraKDBErrorModule (const ElektraError *error) |
const char * | elektraKDBErrorReason (const ElektraError *error) |
int | elektraKDBErrorWarningCount (const ElektraError *error) |
ElektraError * | elektraKDBErrorGetWarning (const ElektraError *error, int index) |
Key * | elektraKDBErrorKey (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... | |
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 a 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 a 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... | |
#define ELEKTRA_TAG_DECLARATIONS | ( | cType, | |
typeName | |||
) |
Inserts the necessary declarations for a new Elektra Tag that can be used in combination with the generic getter and setter macros.
cType | The C-Type of the value described by the tag. |
typeName | The unique identifier of this type that can be used as part of a C identifier. |
#define ELEKTRA_TAG_DEFINITIONS | ( | cType, | |
typeName, | |||
KDB_TYPE, | |||
VALUE_TO_STRING, | |||
KEY_TO_VALUE | |||
) |
Inserts the necessary definitions for an Elektra Tag declared with ELEKTRA_TAG_DECLARATIONS.
cType | Exact same value as in ELEKTRA_TAG_DECLARATIONS |
typeName | Exact same value as in ELEKTRA_TAG_DECLARATIONS |
KDB_TYPE | The KDBType used in the type metadata of a Key. |
VALUE_TO_STRING | A function which converts a value of type cType into a string. The string must be allocated with elektraMalloc(), so that it can be freed with elektraFree(). |
KEY_TO_VALUE | A function which takes a Key an pointer to a variable of type cType and tries to convert the Key into cType . The function must return 1 on success and 0 otherwise. The supermacro "macros/type_create_to_value.h" may be used to create such a function. |
#define ELEKTRA_TAG_VALUE | ( | tagName, | |
keyname, | |||
typeName | |||
) |
Inserts a new static instance of an Elektra Tag.
tagName | The name of the new Tag instance. Will be prefixed with ELEKTRA_TAG_ . |
keyname | The name of the key this Tag instance corresponds to. |
typeName | Exact same value as in ELEKTRA_TAG_DECLARATIONS. This value is used to identify which kind of tag should be created. |
#define elektraGet | ( | elektra, | |
tag | |||
) | ((tag).get (elektra, &(tag))) |
elektra | The elektra instance initialized with the parent key. |
name | The keyname to look up. The keyname is appended to the parent key. |
index | The array index of the desired element, starting with 0. |
#define elektraGetArrayElement | ( | elektra, | |
tag, | |||
index | |||
) | ((tag).getArrayElement (elektra, &(tag), index)) |
elektra | The elektra instance initialized with the parent key. |
keyName | The keyname (or a codegenerated Tag) to look up. The keyname is appended to the parent key. |
value | The new value. |
index | The array index of the desired element, starting with 0. \ |
#define elektraSet | ( | elektra, | |
tag, | |||
value, | |||
error | |||
) | ((tag).set (elektra, &(tag), value, error)) |
elektra | The elektra instance initialized with the parent key. |
tag | The codegenerated Tag to write to. |
value | The new value. |
error | Pass a reference to an ElektraError pointer. |
#define elektraSetArrayElement | ( | elektra, | |
tag, | |||
index, | |||
value, | |||
error | |||
) | ((tag).setArrayElement (elektra, &(tag), index, value, error)) |
elektra | The elektra instance initialized with the parent key. |
tag | The code-generated tag to write to. |
value | The new value. |
error | Pass a reference to an ElektraError pointer. |
kdb_long_long_t elektraArraySize | ( | Elektra * | elektra, |
const char * | name | ||
) |
Gets the size of an array.
elektra | The Elektra instance to use. |
name | The (relative) name of the array. |
void elektraClose | ( | Elektra * | elektra | ) |
Releases all resources used by the given elektra instance.
The elektra instance must not be used anymore after calling this.
elektra | An Elektra instance. |
ElektraErrorCode elektraErrorCode | ( | const ElektraError * | error | ) |
const char* elektraErrorDescription | ( | const ElektraError * | error | ) |
ElektraErrorSeverity elektraErrorSeverity | ( | const ElektraError * | error | ) |
void elektraFatalError | ( | Elektra * | elektra, |
ElektraError * | fatalError | ||
) |
Promote an ElektraError to fatal and call the fatal error handler.
elektra | Elektra instance whose fatal error handler shall be used. |
fatalError | The error that will be raised. |
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.
elektra | An Elektra instance. |
fatalErrorHandler | The error handler that will be used henceforth. |
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.
elektra | The Elektra instance to use. |
name | The relative name of the array. |
index | The index of the array element. |
type | The expected type metadata value. |
name
or NULL, if a fatal error occurs and the fatal error handler returns to this function 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.
elektra | The Elektra instance to use. |
name | The relative name of the key. |
type | The expected type metadata value. |
name
or NULL, if a fatal error occurs and the fatal error handler returns to this function KDBType elektraGetArrayElementType | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index | ||
) |
Reads the type metadata of a given array element.
elektra | An Elektra instance. |
name | The name of the array. |
index | The index of the array element whose type information shall be read. |
kdb_boolean_t elektraGetBoolean | ( | Elektra * | elektra, |
const char * | keyname | ||
) |
Gets a boolean value.
elektra | The elektra instance to use. |
keyname | The (relative) name of the key to look up. |
kdb_boolean_t elektraGetBooleanArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index | ||
) |
Gets a boolean value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to look up. |
index | The index of the array element to look up. |
kdb_char_t elektraGetChar | ( | Elektra * | elektra, |
const char * | keyname | ||
) |
Gets a char value.
elektra | The elektra instance to use. |
keyname | The (relative) name of the key to look up. |
kdb_char_t elektraGetCharArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index | ||
) |
Gets a char value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to look up. |
index | The index of the array element to look up. |
kdb_double_t elektraGetDouble | ( | Elektra * | elektra, |
const char * | keyname | ||
) |
Gets a double value.
elektra | The elektra instance to use. |
keyname | The (relative) name of the key to look up. |
kdb_double_t elektraGetDoubleArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index | ||
) |
Gets a double value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to look up. |
index | The index of the array element to look up. |
kdb_float_t elektraGetFloat | ( | Elektra * | elektra, |
const char * | keyname | ||
) |
Gets a float value.
elektra | The elektra instance to use. |
keyname | The (relative) name of the key to look up. |
kdb_float_t elektraGetFloatArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index | ||
) |
Gets a float value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to look up. |
index | The index of the array element to look up. |
kdb_long_t elektraGetLong | ( | Elektra * | elektra, |
const char * | keyname | ||
) |
Gets a long value.
elektra | The elektra instance to use. |
keyname | The (relative) name of the key to look up. |
kdb_long_t elektraGetLongArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index | ||
) |
Gets a long value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to look up. |
index | The index of the array element to look up. |
kdb_long_long_t elektraGetLongLong | ( | Elektra * | elektra, |
const char * | keyname | ||
) |
Gets a long long value.
elektra | The elektra instance to use. |
keyname | The (relative) name of the key to look up. |
kdb_long_long_t elektraGetLongLongArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index | ||
) |
Gets a long long value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to look up. |
index | The index of the array element to look up. |
kdb_octet_t elektraGetOctet | ( | Elektra * | elektra, |
const char * | keyname | ||
) |
Gets a octet value.
elektra | The elektra instance to use. |
keyname | The (relative) name of the key to look up. |
kdb_octet_t elektraGetOctetArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index | ||
) |
Gets a octet value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to look up. |
index | The index of the array element to look up. |
const char * elektraGetRawString | ( | Elektra * | elektra, |
const char * | name | ||
) |
Get the raw string value of a key.
elektra | The Elektra instance to use. |
name | The (relative) name of the key. |
const char * elektraGetRawStringArrayElement | ( | Elektra * | elektra, |
const char * | name, | ||
kdb_long_long_t | index | ||
) |
Get the raw string value of an array element key.
elektra | The Elektra instance to use. |
name | The (relative) name of the array. |
index | The index of the array element. |
kdb_short_t elektraGetShort | ( | Elektra * | elektra, |
const char * | keyname | ||
) |
Gets a short value.
elektra | The elektra instance to use. |
keyname | The (relative) name of the key to look up. |
kdb_short_t elektraGetShortArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index | ||
) |
Gets a short value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to look up. |
index | The index of the array element to look up. |
const char * elektraGetString | ( | Elektra * | elektra, |
const char * | keyname | ||
) |
Gets a string value.
elektra | The elektra instance to use. |
keyname | The (relative) name of the key to look up. |
const char * elektraGetStringArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index | ||
) |
Gets a string value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to look up. |
index | The index of the array element to look up. |
KDBType elektraGetType | ( | Elektra * | elektra, |
const char * | keyname | ||
) |
Reads the type metadata of a given key.
elektra | An Elektra instance. |
keyname | The name of the key whose type information shall be read. |
kdb_unsigned_long_t elektraGetUnsignedLong | ( | Elektra * | elektra, |
const char * | keyname | ||
) |
Gets a unsigned long value.
elektra | The elektra instance to use. |
keyname | The (relative) name of the key to look up. |
kdb_unsigned_long_t elektraGetUnsignedLongArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index | ||
) |
Gets a unsigned long value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to look up. |
index | The index of the array element to look up. |
kdb_unsigned_long_long_t elektraGetUnsignedLongLong | ( | Elektra * | elektra, |
const char * | keyname | ||
) |
Gets a long long value.
elektra | The elektra instance to use. |
keyname | The (relative) name of the key to look up. |
kdb_unsigned_long_long_t elektraGetUnsignedLongLongArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index | ||
) |
Gets a unsigned long long value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to look up. |
index | The index of the array element to look up. |
kdb_unsigned_short_t elektraGetUnsignedShort | ( | Elektra * | elektra, |
const char * | keyname | ||
) |
Gets a unsigned short value.
elektra | The elektra instance to use. |
keyname | The (relative) name of the key to look up. |
kdb_unsigned_short_t elektraGetUnsignedShortArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index | ||
) |
Gets a unsigned short value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to look up. |
index | The index of the array element to look up. |
int elektraKDBErrorCode | ( | const ElektraError * | error | ) |
const char* elektraKDBErrorDescription | ( | const ElektraError * | error | ) |
ElektraError* elektraKDBErrorGetWarning | ( | const ElektraError * | error, |
int | index | ||
) |
the returned error will always have the following properties:
NOTE: you have to free the memory allocated by this function using elektraFree()
ElektraKDBErrorGroup elektraKDBErrorGroup | ( | const ElektraError * | error | ) |
Key* elektraKDBErrorKey | ( | const ElektraError * | error | ) |
ElektraKDBErrorModule elektraKDBErrorModule | ( | const ElektraError * | error | ) |
const char* elektraKDBErrorReason | ( | const ElektraError * | error | ) |
ElektraErrorSeverity elektraKDBErrorSeverity | ( | const ElektraError * | error | ) |
int elektraKDBErrorWarningCount | ( | const ElektraError * | error | ) |
void elektraSetBoolean | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_boolean_t | value, | ||
ElektraError ** | error | ||
) |
Sets a boolean value.
elektra | The elektra instance to use. |
keyname | The (relative) name to write to. |
value | The new boolean value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetBooleanArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index, | ||
kdb_boolean_t | value, | ||
ElektraError ** | error | ||
) |
Sets a boolean value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to write to. |
index | The index of the array element to write to. |
value | The new boolean value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetChar | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_char_t | value, | ||
ElektraError ** | error | ||
) |
Sets a char value.
elektra | The elektra instance to use. |
keyname | The (relative) name to write to. |
value | The new char value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetCharArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index, | ||
kdb_char_t | value, | ||
ElektraError ** | error | ||
) |
Sets a char value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to write to. |
index | The index of the array element to write to. |
value | The new char value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetDouble | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_double_t | value, | ||
ElektraError ** | error | ||
) |
Sets a double value.
elektra | The elektra instance to use. |
keyname | The (relative) name to write to. |
value | The new double value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetDoubleArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index, | ||
kdb_double_t | value, | ||
ElektraError ** | error | ||
) |
Sets a double value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to write to. |
index | The index of the array element to write to. |
value | The new double value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetFloat | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_float_t | value, | ||
ElektraError ** | error | ||
) |
Sets a float value.
elektra | The elektra instance to use. |
keyname | The (relative) name to write to. |
value | The new float value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetFloatArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index, | ||
kdb_float_t | value, | ||
ElektraError ** | error | ||
) |
Sets a float value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to write to. |
index | The index of the array element to write to. |
value | The new float value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetLong | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_t | value, | ||
ElektraError ** | error | ||
) |
Sets a long value.
elektra | The elektra instance to use. |
keyname | The (relative) name to write to. |
value | The new long value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetLongArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index, | ||
kdb_long_t | value, | ||
ElektraError ** | error | ||
) |
Sets a long value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to write to. |
index | The index of the array element to write to. |
value | The new long value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetLongLong | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | value, | ||
ElektraError ** | error | ||
) |
Sets a long long value.
elektra | The elektra instance to use. |
keyname | The (relative) name to write to. |
value | The new long long value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
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.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to write to. |
index | The index of the array element to write to. |
value | The new long long value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetOctet | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_octet_t | value, | ||
ElektraError ** | error | ||
) |
Sets a octet value.
elektra | The elektra instance to use. |
keyname | The (relative) name to write to. |
value | The new octet value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetOctetArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index, | ||
kdb_octet_t | value, | ||
ElektraError ** | error | ||
) |
Sets a octet value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to write to. |
index | The index of the array element to write to. |
value | The new octet value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetRawString | ( | Elektra * | elektra, |
const char * | name, | ||
const char * | value, | ||
KDBType | type, | ||
ElektraError ** | error | ||
) |
Set the raw string value of a key.
elektra | The Elektra instance to use. |
name | The (relative) name of the key. |
value | The raw value to set. |
type | The type to set in the metadata of the key. |
error | Pointer to an ElektraError. Will be set in case saving fails. |
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.
elektra | The Elektra instance to use. |
name | The (relative) name of the array. |
index | The index of the array element. |
value | The raw value to set. |
type | The type to set in the metadata of the (array element) key. |
error | Pointer to an ElektraError. Will be set in case saving fails. |
void elektraSetShort | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_short_t | value, | ||
ElektraError ** | error | ||
) |
Sets a short value.
elektra | The elektra instance to use. |
keyname | The (relative) name to write to. |
value | The new short value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetShortArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index, | ||
kdb_short_t | value, | ||
ElektraError ** | error | ||
) |
Sets a short value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to write to. |
index | The index of the array element to write to. |
value | The new short value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetString | ( | Elektra * | elektra, |
const char * | keyname, | ||
const char * | value, | ||
ElektraError ** | error | ||
) |
Sets a string value.
elektra | The elektra instance to use. |
keyname | The (relative) name to write to. |
value | The new string value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetStringArrayElement | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_long_long_t | index, | ||
const char * | value, | ||
ElektraError ** | error | ||
) |
Sets a string value array element.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to write to. |
index | The index of the array element to write to. |
value | The new string value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetUnsignedLong | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_unsigned_long_t | value, | ||
ElektraError ** | error | ||
) |
Sets a unsigned long value.
elektra | The elektra instance to use. |
keyname | The (relative) name to write to. |
value | The new unsigned long value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
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.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to write to. |
index | The index of the array element to write to. |
value | The new unsigned long value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetUnsignedLongLong | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_unsigned_long_long_t | value, | ||
ElektraError ** | error | ||
) |
Sets a unsigned long long value.
elektra | The elektra instance to use. |
keyname | The (relative) name to write to. |
value | The new unsigned long long value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
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.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to write to. |
index | The index of the array element to write to. |
value | The new unsigned long long value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
void elektraSetUnsignedShort | ( | Elektra * | elektra, |
const char * | keyname, | ||
kdb_unsigned_short_t | value, | ||
ElektraError ** | error | ||
) |
Sets a unsigned short value.
elektra | The elektra instance to use. |
keyname | The (relative) name to write to. |
value | The new unsigned short value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |
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.
elektra | The elektra instance to use. |
keyname | The (relative) name of the array to write to. |
index | The index of the array element to write to. |
value | The new unsigned short value. |
error | Pass a reference to an ElektraError pointer. Will only be set in case of an error. |